执行摘要
- 一句话:Ascend 文档目录重构与内容优化
- 推荐动作:建议阅读本 PR 的文档结构变化以了解当前 Ascend 文档的组织方式,但不建议直接引用其中的路径和配置示例(因存在已知错误)。后续应追踪修复评论中提出的问题,并为删除的文档设置重定向或通知。
功能与动机
PR body 仅说明 'verl Ascend doc refactor',但从变更内容看,主要目的是将过去散落在 examples、profiling 等目录的文档统一归入 model_support、dev_guide 等结构化目录,新增 README 以提供清晰的导航,并淘汰过时内容(如 run_qwen3_32B_megatron_1k_256k_npu.md)。此前有多项 NPU 文档 PR(如 #6337、#6347)已逐步调整,本次重构是这些工作的集中整合。
实现拆解
- 新增顶层导航文件:在 docs/ascend_tutorial/ 下新增 README.md,列出快速开始、特性支持、模型支持、开发指南等模块的目录结构及其链接。
- 目录重组:将原位于 examples/ 下的多个最佳实践文档(ascend_sglang_best_practices.rst、ascend_retool_best_pratice.rst、dapo_multi_model_optimization_practice.md、gspo_optimization_practice.md)移至 model_support/examples/;将 profiling/ 下的两个 profiling 文档(ascend_profiling_zh.rst、ascend_profiling_en.rst)和 ascend_performance_analysis_guide.md 移至 dev_guide/performance/;删除 examples/run_qwen3_32B_megatron_1k_256k_npu.md 和 feature_support/ascend_consistency.rst。
- 新增评测指南:创建 dev_guide/model_dev/evaluation.md,详细说明使用 AISBenchmark 进行模型评测的步骤(包括 vLLM 和 sglang 后端)。
- 更新全局索引:修改 docs/index.rst,移除已删除文件的条目,调整路径以匹配新目录结构。
- 内容微调:在 ascend_sglang_best_practices.rst 中修正了脚本链接的 commit id、更新了硬件表格、优化了部分描述。
- 未修正的已知错误:review 指出的反斜杠路径、端口不匹配、设备索引超限、URL 指向错误等问题在合并版本中仍存在。
关键文件:
docs/ascend_tutorial/dev_guide/model_dev/evaluation.md(模块 开发指南;类别 docs;类型 documentation): 新增模型评测指南,是本次重构的核心新增内容,但 review 发现两处 high priority 错误。
docs/ascend_tutorial/README.md(模块 入口文档;类别 docs;类型 documentation): 新增的顶层 README,作为整个 Ascend 教程的目录入口,对用户导航至关重要。
docs/ascend_tutorial/model_support/examples/ascend_sglang_best_practices.rst(模块 最佳实践;类别 docs;类型 rename-or-move): 被移动并修改内容(更新引用脚本的 commit id 等),但 review 也发现了设备索引和 URL 问题。
docs/index.rst(模块 全局索引;类别 docs;类型 documentation): 必须更新以反映所有文件的新路径和删除,是文档可被 sphinx 正确构建的关键。
关键符号:未识别
评论区精华
Gemini Code Assist 在 review 中发现了 4 个高优先级问题,均未得到作者回应即被合并:
风险与影响
- 风险:文档变更本身风险较低,但 review 指出的 4 个错误均为 high priority 且未被修正,直接降低了文档的可靠性和可用性:
- 反斜杠路径在非 Windows 环境下无效,可能导致用户无法跳转到参考文档。
- 端口不匹配会导致评估流程失败,用户需要自行调试发现不一致。
- 设备索引溢出可能导致训练/评测脚本因索引越界报错。
- 错误 profiling 链接(指向 volcengine 而非 verl-project)使用户无法到达预期页面。
- 删除的文档(run_qwen3_32B_megatron_1k_256k_npu.md)如果被外部引用,将出现 404。
- 影响:影响范围:所有通过网站或 GitHub 查阅 verl Ascend 文档的用户。目录重构后用户需要适应新路径,但 README 的加入提供了良好指引。训练示例和评测指南的整合使文档更聚焦,但存在的内容错误可能使用户信任度下降。对系统无影响。
- 风险标记:文档路径错误易导致404, 端口不一致使评测流程失败, 设备索引超限, URL指向错误仓库
关联脉络
- PR #6337 [doc] chore: split install guidance and quickstart: 同属 Ascend 文档重构系列,此前已拆分安装与快速入门指南,本 PR 进一步将其他文档归入统一目录结构。
- PR #6347 [doc] refactor: added the document that collects statistics on models and algorithms that support the NPU: 新增模型支持文档,本 PR 将其链接纳入 README 并调整了 examples 路径。
- PR #6339 [doc] chore: add npu advanced features: 新增 NPU 高级特性文档,本 PR 也调整了其目录位置。
- PR #6328 [doc] refactor: Ascend docs rectification, add new FAQ questions: 此前已对 FAQ 进行修正,本 PR 是更大范围的结构性重构。
参与讨论