Prhub

#23712 [Doc]Add msprobe doc in docs_new path

原始 PR 作者 is-not 合并时间 2026-04-27 15:06 文件变更 3 提交数 1 评论 8 代码增减 +602 / -1

执行摘要

在 docs_new 中添加 MSProbe 调试指南

根据 PR 描述,目的是在 docs_new 路径中添加 msprobe 文档,为开发者提供 MSProbe 调试工具的使用指导。

建议快速合并。此 PR 为团队开发者提供了重要的调试工具文档,评审已通过,技术争议已澄清。对于关注 NPU 调试和模型精度问题的工程师,值得仔细阅读文档中的配置与示例部分。

讨论亮点

Review 由 gemini-code-assist[bot] 发起,共提出 4 条中等优先级评论:

  • 术语“pynative”:建议替换为 PyTorch 生态的 “eager mode”,以避免混淆(ping1jing2 赞同)。
  • 格式空格:建议在括号前添加空格以保持排版一致性。
  • 拼写错误srep0 应为 step0
  • 技术不一致summary_mode="md5" 时描述中却提及 CRC-32,is-not 回应“这是命名问题,实际转储为 CRC-32”。

上述评论除 CRC-32 命名获作者澄清外,其余预计已在后续提交中修正。

实现拆解

  1. 创建核心文档:新增 docs_new/docs/developer_guide/msprobe_debugging_guide.mdx,包含 MSProbe 的背景概念(L0/L1/mix 转储级别)、安装方法、关键参数配置表(task、dump_path、rank、step、summary_mode、list 等),以及端到端调试示例与故障排查步骤。

  2. 注册导航路径:修改 docs_new/docs.json,在 Developer Guide 的 pages 数组末尾添加 "docs/developer_guide/msprobe_debugging_guide",使文档在侧边导航中可访问。

  3. 更新概览页面:在 docs_new/docs/developer_guide/overview.mdx 的链接列表末尾追加一行 - [MSProbe Debugging Guide](./msprobe_debugging_guide),确保用户可从开发指南总览页跳转。

  4. 无测试或配置配套变更:本次为纯文档添加,未涉及代码、测试或部署配置。

文件 模块 状态 重要度
docs_new/docs/developer_guide/msprobe_debugging_guide.mdx 开发者文档 added 5.22
docs_new/docs.json 站点配置 modified 2.6
docs_new/docs/developer_guide/overview.mdx 开发者文档 modified 1.6

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

术语“pynative”应替换为“eager mode” documentation

gemini-code-assist[bot] 指出 'pynative' 是 MindSpore 术语,建议使用 PyTorch 中的“eager mode”或直接说明 PyTorch,以避免混淆。ping1jing2 评论“make sense”表示赞同。

结论: Reviewer 建议被采纳,预计文档已修改为使用“eager mode”。 · 已解决

格式:括号前缺少空格 style

gemini-code-assist[bot] 建议在 Note 文本的括号前加空格以提升可读性。ping1jing2 表示认同。

结论:格式问题已根据建议修正。 · 已解决

技术不一致:CRC-32 与 MD5 的混淆 正确性

gemini-code-assist[bot] 发现 summary_mode="md5" 时文档描述中却提及 CRC-32,认为可能是笔误。is-not 回应“这是命名问题,实际 dump 是 'CRC-32'”,澄清了工具内部命名即 CRC-32。

结论:作者澄清命名一致,文档无需修改,争议解决。 · 已解决

风险与影响

文档变更不涉及运行代码,无回归、性能或安全风险。主要风险在于术语准确性:若保留“pynative”等 MindSpore 特定术语,可能对 PyTorch 用户造成困惑;但作者已在评论中澄清 CRC-32 的命名逻辑,整体影响可控。

对开发者而言,新增了一篇完整的调试指南,尤其对使用 NPU 进行模型精度调试的场景帮助明显。对系统无影响。文档变更范围局限于 docs_new 目录,不影响任何运行时行为。

术语准确性 文档内容待完善

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论