执行摘要
本 PR 是纯文档维护变更,针对 NPU 教程中的安装指导、快速开始和多节点实践文档进行修正,包括脚本路径、依赖版本分支、配置示例和链接格式。共修改 4 个 RST 文件,无源码逻辑改动。审阅人已批准合并。
功能与动机
PR body 明确指出本次修改的是安装指导文档和多节点实践文档。结合仓库近期 PR(#7238 更新 vLLM/vLLM-Ascend 版本、#7268 更新 CANN 版本),本次修改是为了让文档与最新依赖版本和实际脚本路径保持一致,避免用户按旧文档操作时出现安装失败或配置错误。例如 install_guidance.rst 中 Megatron-LM 分支从 core_v0.12.1 升级为 core_r0.16.0,与仓库当前支持的 Megatron 版本对齐。
实现拆解
本 PR 无源码与测试配套变更,按文件拆解如下:
-
多节点实践文档(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 卡实际配置
-
安装指导文档(docs/ascend_tutorial/get_start/install_guidance.rst)
- 为 triton-ascend 补充安装命令说明,指引用户参考 scripts/install_vllm_mcore_npu.sh
- 修正 FSDP 后端的脚本调用路径为 bash verl/scripts/install_vllm_mcore_npu.sh
- 将 MindSpeed-LLM 依赖的 Megatron-LM 分支从 core_v0.12.1 升级为 core_r0.16.0
-
A5 安装指导(docs/ascend_tutorial/get_start/install_guidance_A5.rst)
- 修正 PYTHONPATH 路径占位符从 your path 改为 your_path,避免复制时误解为空格
-
快速开始文档(docs/ascend_tutorial/get_start/quick_start.rst)
- 将多节点任务拉起的 :doc: 引用改为指向 GitHub 仓库的绝对链接,并修复空行渲染问题
本 PR 为纯文档修改,不涉及源码,无关键代码片段展示。
评论区精华
无人工 review 评论。仅有一条 CLAassistant 机器人评论提示签署 CLA(状态已签署),审阅人 wucong25 直接批准(APPROVED)。
风险与影响
- 风险:纯文档变更风险极低。潜在风险包括:新增的版本号(Megatron-LM
core_r0.16.0)和脚本路径需与仓库后续改动保持同步;绝对链接依赖 GitHub 默认分支路径,若文件被移动会失效;多节点示例按 16 卡机型编写,其他机型用户需自行调整。
- 影响:影响范围限于 NPU 用户的文档阅读与操作,提升安装命令和版本信息的准确性,减少用户踩坑。对团队无功能影响。
关联脉络
- 与 PR#7238(更新 vLLM/vLLM-Ascend 和 torch 版本)同族,均修改了
docs/ascend_tutorial/get_start/install_guidance.rst 与 install_guidance_A5.rst,共同推进 NPU 安装文档与依赖版本的同步。
- 与 PR#7268(CANN 版本升级)、PR#7201(Ascend Docker 镜像改名)同属 Ascend 环境维护线,反映仓库对 NPU 支持持续更新和文档完善的趋势。
参与讨论