👋 您好,欢迎向 MindStudio Probe 提交 Issue!
我们已收到您的反馈,感谢你对开源社区的支持。🎉
📅处理时效: 维护团队将在24小时内 查看并回复您的问题(工作日)。
🔍自助查询: 在等待期间,建议您先查阅以下资料,可能已有解决方案:
📖 MindStudio Probe官方文档
📝 贡献者指南
请确保 Issue 描述清晰,包含复现步骤和日志,这将帮助我们更快定位问题。谢谢!


/label add triaged


Doc 1:docs/zh/wiki/dump_enable_guide.md
工具添加位置 / 确定性 / VERL 集成相关指南
共修复 7 处 bug,主要集中在中文术语统一、英文产品名大小写与代码块 diff 标记。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 1.1 | L15 | 表达优化 | 想要找该在哪添加工具的时候,我们可以任意打印一个API的调用栈信息出来看 | 想要找工具的添加位置时,可以打印目标 API 的调用栈 | 消除冗余、口语化重写 |
| 1.2 | L18 | 术语 | 打印linear的调用栈代码 | 打印 linear 的调用栈 |
API 名应用代码字体 |
| 1.3 | L37 | 注释对齐 | 替换functional中的linear,使用*args和**kwargs | 替换 functional 中的 linear,使用 *args 和 **kwargs | 中英文之间补空格 |
| 1.4 | L41 | 注释对齐 | 调用F.linear,调用栈如下: | 调用 F.linear,调用栈如下: | 补全中文标点 |
| 1.5 | L44 | 表达 | 将接收的参数原封不动地传给原始函数 | 将接收到的参数原封不动地传给原始函数 | "的" → "到" |
| 1.6 | L72 | 表达 | 使能确定性的位置: | 启用确定性(deterministic)配置的位置: | 术语统一,"使能" → "启用" |
| 1.7 | L78 | 术语 | generate_sequences(同行放图片) | generate_sequences(独立行放图片) | 图片独占一行可正常渲染 |
| 1.8 | L82 | 错误 | 以上使能方式只针对vllm eager模式后端 | 以上使能方式只针对 verl fsdp 后端 | 章节是 VERL (fsdp后端),原写 vllm 错误 |
| 1.9 | L145 | 格式 | actor_rollout_ref.rollout.enforce_eager=True(与 diff 标记不对齐) |
+ actor_rollout_ref.rollout.enforce_eager=True |
diff 块需要 + 前缀表示新增 |
Doc 2:docs/zh/wiki/infer_debug_guide.md
推理场景精度问题定位指南
共修复 12 处 bug。最严重的是章节编号系统性偏移(vLLM 与 MindIE 两个分支各偏移 1 级)。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 2.1 | L9 | 错字 | 有限字长效应对表示范围 | 有限字长对表示范围 | 删掉多余 "效应" |
| 2.2 | L17 | 表达 | 输出中出现大量、<unk>、’ 等异常符号 | 输出中出现大量乱码字符(如 、`’`)或未知 token(如 `<unk>)等异常符号 |
<unk> 不应用反斜杠转义;用代码字体 |
| 2.3 | L47 | 不完整 | max sequence | max sequence length | 补全单词 |
| 2.4 | L100 | 表达 | 在问题场景和标杆场景直接打印模型配置比对 | 在问题场景和标杆场景中分别打印模型配置并比对 | 加 "分别",语义更准 |
| 2.5 | L104 | 注释 | #初始化模型 / #查看模型配置 | # 初始化模型 / # 查看模型配置 | 注释后空格 |
| 2.6 | L120 | 代码块语言 | ```python | ```text | 输出只是普通文本,非 Python |
| 2.7 | L141 | 严重:场景错误 | 两者都需要在训练开始的代码之前 | 两者都需要在推理脚本启动的代码之前 | 文档是"推理调试指南","训练" → "推理" |
| 2.8 | L188 | 编号偏移 | ##### 4.1.1.2 常用工具介绍 |
##### 4.1.1.1 常用工具介绍 |
应为 4.1.1.1,原文档顺序错位 |
| 2.9 | L191 | 表达 | 以vLLM0.9版本为例下面逐一介绍 | 以 vLLM 0.9 版本为例,下面逐一介绍 | 中英文/数字间补空格 |
| 2.10 | L195 | 编号偏移 | ###### 4.1.1.2.1 V0场景 |
###### 4.1.1.1.1 V0场景 |
随父节调整 |
| 2.11 | L225 | 标点 | enforce_eager=True)(半角括号) | enforce_eager=True)(全角括号) | 与上下文中文标点统一 |
| 2.12 | L225 | 编号偏移 | ###### 4.1.1.2.2 V1场景 |
###### 4.1.1.1.2 V1场景 |
随父节调整 |
| 2.13 | L268 | 编号偏移 | ##### 4.1.1.3 定位流程 |
##### 4.1.1.2 定位流程 |
随父节调整 |
| 2.14 | L271 | 编号偏移 | ###### 4.1.1.3.1 定位前置操作 |
###### 4.1.1.2.1 定位前置操作 |
随父节调整 |
| 2.15 | L292 | 编号偏移 | ###### 4.1.1.3.2 定位过程操作 |
###### 4.1.1.2.2 定位过程操作 |
随父节调整 |
| 2.16 | L296 | 链接错位 | 4.1.1.2 常用工具介绍 | 4.1.1.1 常用工具介绍 | 链接锚点跟随编号变化 |
| 2.17 | L302 | 编号偏移 | ###### 4.1.1.3.3 定位结果分析 |
###### 4.1.1.2.3 定位结果分析 |
随父节调整 |
| 2.18 | L313 | 编号偏移(MindIE 分支) | ##### 4.1.2.2 常用工具介绍 |
##### 4.1.2.1 常用工具介绍 |
MindIE 分支同样编号错位 |
| 2.19 | L332 | 标点 | 需要注意的是 | 需要注意的是: | 补全冒号 |
| 2.20 | L396 | 编号偏移 | ##### 4.1.2.3 定位流程 |
##### 4.1.2.2 定位流程 |
MindIE 分支随父节调整 |
2.7、2.8、2.13、2.18 这 4 处是严重级别 bug:场景性错误和系统性编号错位会直接误导读者跳到错误的章节。
Doc 4:docs/zh/dump/pytorch_data_dump_instruct.md
PyTorch 数据采集指南
共修复 13 处 bug。包含:API 名大小写、代码块语言、framework 字段值、树状图字符统一、Null/null、空白处理等。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 4.1 | L27 | 术语 | 使用原型函数PrecisionDebugger | 使用 PrecisionDebugger 类 |
应为类;用代码字体 |
| 4.2 | L302 | 表达 | 指定采集推理模型逐字符循环推理中的第1~3次 | 指定采集推理模型逐 token 循环推理中的第 1~3 次 | "字符" → "token";空格 |
| 4.3 | L317 | 代码块语言 | ```ColdFusion | ```text | ColdFusion 是语法高亮语言,与文本不符 |
| 4.4 | L335-L358 | 树状字符 | 多处 `│ | (混用 │与|`) |
统一为 │ │ |
| 4.5 | L393 | 格式 | | Triton | triton | |
| Triton | triton | |
表格对齐 |
| 4.6 | L421 | 字段值错误 | "framework": "pytorch" |
"framework": "PyTorch" |
示例应使用规范大小写 |
| 4.7 | L591 | 字段值错误 | "framework": "pytorch" |
"framework": "PyTorch" |
同上 |
| 4.8 | L666 | 格式 | "requires_grad": false, (行末多空格) |
"requires_grad": false, |
删多余空格 |
| 4.9 | L689 | 术语 | 在 dump 结果中置为Null |
在 dump 结果中置为 null |
JSON 中应为小写 null,代码字体 |
| 4.10 | L901 | 表达 | 不会dump传入层的子层级...dumpA.x, A.x.xx等 | 不会 dump 传入层的子层级...dump A.x, A.x.xx 等 | 中英文/标点间补空格 |
| 4.11 | L979 | 表达 | 该接口为函数模块化接口 | 该接口为模块化接口 | 去掉冗余"函数" |
| 4.12 | L1008 | 表达 | 在module_dump和module_dump_end之间的API...除了传入的module | 在 module_dump 和 module_dump_end 之间的 API...除了传入的 module 本身 |
代码字体 + 补字 |
| 4.13 | L1200 | 表达 | num1和num2是能对应的...num1不等于num2 | num1 和 num2 能够保持一致;...num1 不等于 num2 | 修反义,前句改肯定式 |
Doc 5:docs/zh/monitor_instruct.md
训练监控工具使用指南
共修复 13 处 bug。最关键:3 处 TrainerMon 的 API 签名错误与源码不一致,必须修正。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 5.1 | L32 | JSON 格式 | "ops": ["min","max", "mean", "norm"] |
"ops": ["min", "max", "mean", "norm"] |
元素间空格统一 |
| 5.2 | L41 | 术语 | Pytorch使能方式: | PyTorch 使能方式: | 大小写 + 中文标点 |
| 5.3 | L76 | 代码 | def _inner_training_loop: |
def _inner_training_loop(self, ...): |
与 transformers 实际签名一致 |
| 5.4 | L85 | 术语 | MindSpore使能方式: | MindSpore 使能方式: | 同 5.2 |
| 5.5 | L229 | 冗字 | 工具会在在第一个step后 | 工具会在第一个 step后 | 删多余 "在";空格 |
| 5.6 | L365 | 表达 | 我们在alert中支持dump配置项 | alert 中还支持 dump 配置项 | 表达更清晰;空格 |
| 5.7 | L443 | 错字 | 前三个参数用来指定 | 前两个必填参数...用来指定 | 实际是 2 个必填参数 |
| 5.8 | L450 | 字段名错误 | {curtime}_csv2tensorboard_by_step |
{cur_time}_csv2tensorboard_by_step |
变量名为 cur_time |
| 5.9 | L473 | 标点 | 注意事项: | 注意事项 | 与上下文标题标点风格统一(去掉多余冒号) |
| 5.10 | L545 | API 签名 | TrainerMon.__init__(config_file_path, process_group=None, params_have_main_grad=True) |
TrainerMon.__init__(config_file_path, process_group=None, params_have_main_grad=True, opt_ty=None) |
源码新增了 opt_ty 参数 |
| 5.11 | L558 | API 签名 | set_monitor(model, grad_acc_steps, optimizer, dp_group=None, tp_group=None, start_iteration=0) |
set_monitor(model, optimizer, grad_acc_steps=1, tp_group=None, dp_group=None, start_iteration=0) |
1) optimizer 是必传;2) 参数顺序与默认值与源码不符 |
| 5.12 | L583 | 字段名错误 | "{curtime}_csv2tensorboard_by_step" |
"{cur_time}_csv2tensorboard_by_step" |
同 5.8 |
| 5.13 | L585 | API 签名 | TrainerMon.generate_wgrad_metrics() -> tuple[dict, dict] |
TrainerMon.generate_wgrad_metrics(post_grad_dict) -> tuple[dict, dict] |
必须传 post_grad_dict |
| 5.14 | L636 | 参数名 | TrainerMon.__init__(config_file_path, process_group=None, param_have_main_grad=True) |
...params_have_main_grad=True... |
参数名应为 params_have_main_grad(多了 s) |
| 5.15 | L705 | 术语 | zeros代表监测所选张量的元素小于eps的比例 | zeros 代表监测所选张量的元素绝对值小于等于 eps的比例 | 补 "绝对值小于等于" 才是数学准确的定义 |
5.10、5.11、5.13、5.14 是严重级别 bug:API 签名错误会让用户调不通接口。
Doc 6:docs/zh/accuracy_compare/pytorch_accuracy_compare_instruct.md
PyTorch 精度比对指南
共修复 7 处 bug。包括 JSON/YAML 语法错误、LaTeX 公式错误、表格错误。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 6.1 | L167 | 代码块语言 | ```ColdFusion | ```text | 树状结构用 text |
| 6.2 | L270 | YAML 多余键 | mode: right_matmul 出现在通用示例最后 |
删除该行 | 通用示例不应有 mode |
| 6.3 | L313 | 表达 | 可以通过:Result、Err_Message... | 可以通过 Result、Err_Message... | 中文标点 |
| 6.4 | L357 | LaTeX 错误 | EucDist: ${\vert\vert{A-B}\vert\vert}_2$ |
EucDist: $\vert\vert{N-B}\vert\vert_2$ |
1) 同行其他公式用 N、B 变量;2) 大括号多余;3) 下标位置错 |
| 6.5 | L558 | dtype 值错误 | "dtype": "torch_float32" |
"dtype": "torch.float32" |
PyTorch dtype 用 . 分隔 |
| 6.6 | L596 | JSON 错误 | "return_indices": {...}, },(多一个 },) |
"return_indices": {...} }, |
删除多余闭合花括号 |
| 6.7 | L620 | 代码块语言 | ```ColdFusion | ```text | 同 6.1 |
| 6.8 | L630 | 代码块语言 | ```ColdFusion | ```text | 同 6.1 |
| 6.9 | L636 | 代码块语言 | ```ColdFusion | ```text | 同 6.1 |
| 6.10 | L656 | 转义错 | 文件名格式:*.yaml | 文件名格式:*.yaml | markdown 中 \* 是错误的转义 |
6.4、6.5、6.6 是严重级别 bug:直接导致示例无法运行或公式渲染失败。
Doc 7:docs/zh/accuracy_compare/pytorch_visualization_instruct.md
PyTorch 可视化指南
共修复 9 处 bug。包括 ubuntu 占位符、Windows 10 空格、tree 字符、ColdFusion 代码块等。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 7.1 | L367 | 表达 | **ubuntu需要替换为真实的服务器地址... | **页面中显示的地址需要替换为真实的服务器地址... | "ubuntu" 只是 placeholder,应说明 "页面中显示的地址" |
| 7.2 | L371 | 格式 | Windows10 | Windows 10 | 补空格 |
| 7.3 | L387 | 术语 | vscode / vscode | VS Code / VS Code | 产品名规范大小写 |
| 7.4 | L404-L406 | 代码块内格式 | 空行 + 4 空格缩进 | 单行无缩进 | 代码块内文本不应带前导空格(导致渲染异常) |
| 7.5 | L528 | 表达 | rw- r-- --- | rw-r-- --- | 删多余空格,与上方 rwx r-x --- 风格一致 |
| 7.6 | L628 | 转义错 | *.yaml | *.yaml | 删反斜杠 |
| 7.7 | L686 | 代码块语言 | ```ColdFusion | ```text | 同前 |
| 7.8 | L687-L713 | 树状字符 | 多处 │ | 与 | | 混用 |
统一为 │ │ |
markdown 树状图 |
| 7.9 | L708 | 树状字符(混合空格) | │ | ***(2 空格) |
│ │ ***(3 空格) |
与上文 3 空格的缩进对齐 |
Doc 8:docs/zh/accuracy_compare/trend_visualization_instruct.md
趋势可视化指南
共修复 10 处 bug。包括 ubuntu 占位符、Windows 10 空格、无效 IP 地址 10.123.456.78、树状字符等。
| # | 行号 | Bug 类型 | 修改前 | 修改后 | 说明 |
|---|---|---|---|---|---|
| 8.1 | L5 | 表达 | 从迭代步数step、节点rank和张量目标三个维度 | 从迭代步数 Step、节点 Rank 和张量目标三个维度 | 中英文间补空格 |
| 8.2 | L88 | 表达 | 从迭代步数step、节点rank | 从迭代步数 Step、节点 Rank | 同上 |
| 8.3 | L115 | 占位符说明 | 上图中,ubuntu是机器地址 | 上图中显示的地址是机器地址 | "ubuntu" 是 placeholder |
| 8.4 | L117 | 无效 IP | 10.123.456.78 | 10.123.156.78 | IP 第 3 段必须 ≤ 255,原值 456 非法 |
| 8.5 | L121 | 格式 | Windows10 | Windows 10 | 补空格 |
| 8.6 | L137 | 术语 | vscode / vscode | VS Code / VS Code | 产品名 |
| 8.7 | L251 | 表达 | Megatron模型并行可视化是为[展示热力图]功能提供 | Megatron 模型并行可视化是 [展示热力图] 功能的补充,为 | "为...提供..." 句式不通 |
| 8.8 | L255 | 表达 | 仅支持节点rank数小于等于1024 | 仅支持节点 rank 数小于等于 1024 | 空格 |
| 8.9 | L290 | 表达 | 生成一个png文件, 格式为... |
生成一个 PNG 文件,格式为... | "png" → "PNG",逗号改中文 |
| 8.10 | L364-L413 | 树状字符 | 多处 │ | / | | 混用 |
统一为 │ │ |
markdown 树状图 |
8.4 是严重级别 bug:示例 IP 不合法会让用户照抄后无法连接。
修改严重等级汇总
| 严重等级 | Bug 数 | 说明 |
|---|---|---|
| 严重(影响代码/API 运行) | 9 | API 签名错误、JSON/YAML 错误、LaTeX 公式错误、无效 IP、场景性错误 |
| 中等(影响阅读/导航) | 35 | 章节编号偏移、占位符未替换、代码块语言错误、树状字符混用 |
| 轻微(格式/排版) | 27 | 中英文空格、产品名大小写、标点风格 |


认领任务


您好,当前Issue标记为resolved且有一段时间未进一步更新,因此我们将其标记为'stale'(闲置)状态。若您认为这是误操作,可通过添加任意评论来去除'stale'标签。标记为stale的Issue在4天内无更新活动将自动关闭。


在提交新问题之前,请确保您已经在社区中搜索过相关问题,并使用了社区中提供的资源/工具后,仍未找到满意的解决方式。
📚 文档问题描述
参与 MindStudio Probe 官方文档的共建优化,发现并修复文档中存在的错误、表述不清或遗漏内容,通过提交 Issue 和 PR 的方式完成修复,帮助提升文档的准确性和可读性。
文档范围,重点包括但不限于:
大模型训练精度定位指南
大模型推理精度定位指南
常见框架dump工具使能
PyTorch场景精度数据采集
Monitor训练状态轻量化监测工具
PyTorch场景精度比对
PyTorch场景的分级可视化构图比对
趋势可视化
错误范围:
文档错误修正(错别字、语法、格式问题)
描述优化(表述不清晰、逻辑不连贯)
内容补充(遗漏的参数说明、使用示例)
使用问题(参照功能文档无法顺利实现功能)
建议的替代/修复方案
欢迎加入社区,感谢您对社区的贡献 🎉!