Prhub

#6337 [doc] chore: split install guidance and quickstart

原始 PR 作者 Mengyuyang 合并时间 2026-05-14 12:03 文件变更 5 提交数 2 评论 9 代码增减 +636 / -578

执行摘要

拆分 Ascend 安装与快速启动文档

原文档将安装和快速启动混在一起,不利于用户按需查阅。此 PR 旨在拆分两者,使安装指南和快速启动各自独立,并更新版本信息。

本 PR 为文档重构,建议用户查阅新版文档以获取最新安装指导。对于开发者,可关注文档结构和版本表的维护方式。

讨论亮点

Review 中主要指出两个文档错误:

  • gemini-code-assist 发现 quick_start.rst 中的链接多了一个 model_support/ 目录,导致链接失效;
  • 同文件中的 MoE 配置注释与示例值矛盾,注释要求 enable_dp_attention=True 但示例设为 False
    另外 hustmf 要求将文档目录从 quick_start 改为 get_start,并删除多余内容、澄清部分表述。作者均已回复并修改合入。

实现拆解

  1. 删除旧文档 ascend_quick_start.rstascend_sglang_quick_start.rst
  2. 创建 get_start/install_guidance.rst:包含完整的安装指引,涵盖硬件支持、后端选择、vLLM 和 SGLang 路线的详细安装步骤。
  3. 创建 get_start/quick_start.rst:提供快速启动示例,包括 Qwen2.5-0.5B GRPO 基础验证场景。
  4. 更新 docs/index.rst:将 toctree 中的旧条目替换为新文件路径。
文件 模块 状态 重要度
docs/ascend_tutorial/get_start/install_guidance.rst 安装指南 added 5.44
docs/ascend_tutorial/get_start/quick_start.rst 快速启动 added 4.74
docs/index.rst 文档索引 modified 2.3
docs/ascend_tutorial/quick_start/ascend_quick_start.rst 旧文档 removed 4.47
docs/ascend_tutorial/quick_start/ascend_sglang_quick_start.rst 旧文档 removed 4.46

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

评论区精华

quick_start.rst 链接路径错误 正确性

gemini-code-assist 指出链接路径包含多余的 `model_support/` 目录,会导致链接失效。

结论:作者已修复链接路径。 · 已解决

enable_dp_attention 配置矛盾 正确性

gemini-code-assist 指出注释要求 `enable_dp_attention=True`,但示例设为 `False`,会误导用户。

结论:作者已修正为 `True`。 · 已解决

文档目录结构调整 documentation

hustmf 要求将新增文档从 `quick_start` 目录移动到 `get_start` 目录。

结论:作者已将文件移至 `get_start`。 · 已解决

删除多余内容 documentation

hustmf 要求删除文档中一些不必要的表述。

结论:作者已删除。 · 已解决

澄清 MindSpeed-LLM 描述 documentation

hustmf 提出对 MindSpeed-LLM 的描述可以更准确。

结论:作者已在全篇调整相关描述。 · 已解决

风险与影响

本次变更为纯文档结构调整,不涉及代码逻辑,主要风险在于文档路径变更可能导致旧链接失效,以及新增文档中的版本信息是否与当前一致。但已通过 index.rst 更新和内容审查降低风险。

对用户:文档更清晰地划分安装与启动场景,但老用户需适应新路径。对系统:无影响。对团队:文档维护更模块化,易于更新。

文档路径变更 链接失效风险 配置示例矛盾

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论