Prhub

#6966 [doc] feat: add installation instructions for Atlas 950DT A5

原始 PR 作者 fh188 合并时间 2026-07-07 17:16 文件变更 3 提交数 8 评论 3 代码增减 +80 / -1

执行摘要

添加 Atlas 950DT A5 安装指南

PR 正文明确指出需要为 Atlas 950DT A5 平台提供安装指南,帮助用户快速搭建开发环境,包括所需的软件版本、依赖和环境设置步骤。

如果您使用 Atlas 950DT A5 硬件,此文档是必需参考,建议仔细阅读并按步骤操作。同时,审阅中提到的 vllm-ascend 安装改进建议值得在后续文档版本中补齐,以提高用户一次性成功率。该 PR 本身设计上采用独立文档 + 索引链接的模式,适合作为后续其他硬件指南的参考。

讨论亮点

自动化审阅工具 gemini-code-assist[bot] 提出两个高优先级改进建议:

  • 链接相对路径:在 install_guidance.rst 中使用相对路径代替硬编码的 GitHub URL,以保证本地构建和 Fork 下的链接正确性。最终代码已采纳此建议。
  • vllm-ascend 安装步骤不完整:缺少与 vLLM v0.20.2 对应的分支检出、子模块初始化和 --no-build-isolation 选项,可能导致编译失败。最终代码未体现这些改进,因此该问题在文档中仍然存在。
    审查者 wucong25 最终批准了 PR。

实现拆解

纯文档变更,分为三步:

  1. 新建独立指南 install_guidance_A5.rst:在 docs/ascend_tutorial/get_start/ 下创建完整安装说明,包含依赖版本表格和两种后端(vLLM、MindSpeed-LLM)的安装命令。
  2. 更新主安装指南 install_guidance.rst:在硬件型号列表中添加一行指向新文档的 RST 链接,采用相对路径 install_guidance_A5.rst 而非绝对 URL。
  3. 更新文档索引 index.rst:在 toctree 指令中增加 get_start/install_guidance_A5 条目,使该页面出现在侧栏目录中。
文件 模块 状态 重要度
docs/ascend_tutorial/get_start/install_guidance_A5.rst 文档 added 3.9
docs/ascend_tutorial/get_start/install_guidance.rst 文档 modified 1.72
docs/ascend_tutorial/index.rst 文档 modified 1.18

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

评论区精华

链接使用相对路径 documentation

审阅工具建议将硬编码的 GitHub 绝对 URL 替换为相对路径,以避免文档构建、离线浏览和 Fork 分支下的链接失效。

结论:已采纳,最终代码中使用 `install_guidance_A5.rst` 相对路径。 · 已解决

vllm-ascend 安装步骤不完整 documentation

审阅工具指出 vllm-ascend 安装缺少对应对应 vLLM 版本的分支检出、未初始化子模块、未使用 --no-build-isolation,可能引起编译失败。

结论:未完全采纳,最终文档中未补充这些步骤,该问题仍存在。 · unresolved

风险与影响

技术风险较低,因为纯文档变更。潜在风险包括:

  • 版本过时:依赖版本号固定,若后续软件更新但文档未同步,用户按指南安装可能遇到不兼容。
  • 安装步骤可复现性:vLLM-Ascend 安装缺少分支检出和子模块初始化,不保证在所有环境下成功。
  • 链接断裂:虽然已用相对路径,但未来文件移动可能导致断链。

用户影响:对 Atlas 950DT A5 用户有直接帮助,提供了从零搭建的完整指南,降低了使用门槛。
系统影响:无代码变更,不影响已有功能。
团队影响:文档维护者需关注版本更新,确保指南长期有效。

版本过时风险 安装步骤不完整

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论