Prhub

#7265 [doc] chore: Modified some guide documents for NPU

原始 PR 作者 zhouhengan1211 合并时间 2026-08-05 15:05 文件变更 4 提交数 2 评论 1 代码增减 +12 / -11

执行摘要

更新 NPU 安装指导与多节点实践文档

PR body 明确说明“Modified the install guidance document”和“Modified the multi-node practice document”,属于文档维护工作。结合仓库近期 PR(如 #7238 更新 vLLM/vLLM-Ascend 版本、#7268 更新 CANN 版本),本次修改是为了让安装指导与最新依赖版本和实际脚本路径一致,避免用户按旧文档操作时出现错误。

值得快速浏览,不需要精读。关注点在于文档与仓库实际脚本(scripts/install_vllm_mcore_npu.sh)和依赖版本的同步情况,可作为后续 NPU 相关文档维护的参照。

讨论亮点

无人工 review 评论,仅有一条 CLAassistant 机器人评论,要求签署 CLA(状态显示已签署)。审阅人 wucong25 直接批准(APPROVED)。

实现拆解

本 PR 为纯文档变更,无源码/测试配套,按文件拆解如下:

  1. 多节点实践文档(docs/ascend_tutorial/model_support/examples/multi-machine_task_startup_practice.rst):将示例中的 ASCEND_RT_VISIBLE_DEVICES 从 0-7 扩展为 0-15,NPUS_PER_NODE 从 8 改为 16,并同步更新参数说明表,使示例匹配 Atlas 800T A3 单机 16 卡的实际配置。
  2. 安装指导文档(docs/ascend_tutorial/get_start/install_guidance.rst):将 triton-ascend 的安装说明补充为“安装命令需参考安装脚本”,修正脚本调用路径为 bash verl/scripts/install_vllm_mcore_npu.sh,并将 MindSpeed-LLM 依赖的 Megatron-LM 分支从 core_v0.12.1 升级为 core_r0.16.0,与仓库当前支持的版本对齐。
  3. A5 安装指导(docs/ascend_tutorial/get_start/install_guidance_A5.rst):修正 PYTHONPATH 示例中的路径占位符格式(your pathyour_path),避免复制时误解为字面空格。
  4. 快速开始文档(docs/ascend_tutorial/get_start/quick_start.rst):将多节点任务拉起的 :doc: 交叉引用改为指向 GitHub 仓库的绝对链接,并补充空行修复渲染问题。
文件 模块 状态 重要度
docs/ascend_tutorial/get_start/install_guidance.rst NPU 教程 modified 2.57
docs/ascend_tutorial/model_support/examples/multi-machine_task_startup_practice.rst NPU 教程 modified 2.8
docs/ascend_tutorial/get_start/quick_start.rst NPU 教程 modified 1.82
docs/ascend_tutorial/get_start/install_guidance_A5.rst NPU 教程 modified 1.9

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

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

纯文档变更,无代码逻辑改动,技术风险极低。主要风险是:

1) 文档中新增的版本号(Megatron-LM core_r0.16.0)和路径可能与后续仓库改动脱节,需保持同步更新;
2) 绝对链接依赖 GitHub 默认分支路径,若文件被移动或重命名会失效;
3) 多节点示例 NPU 数从 8 改为 16 仅适用于 Atlas 800T A3 机型,其他机型用户需自行调整。

影响范围限于 NPU 使用者的文档阅读与操作。更新后的安装命令和版本分支能减少用户因路径错误或版本不匹配导致的安装失败;多节点示例贴合 16 卡机型,提升了文档的实用性和准确性。对团队而言是低成本的文档维护,无功能影响。

纯文档变更 版本信息需持续同步

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论