Prhub

#43550 [Doc] Add Ascend NPU tab to the quickstart installation guide

原始 PR 作者 adityasingh2400 合并时间 2026-05-27 16:41 文件变更 2 提交数 3 评论 12 代码增减 +11 / -0

执行摘要

在快速入门指南中新增 Ascend NPU 安装指引

vLLM 快速入门指南中已有 NVIDIA CUDA、AMD ROCm、Google TPU、Apple Silicon 等安装路径,唯独缺少 Ascend NPU,导致使用华为昇腾 NPU 的用户难以发现社区维护的 vllm-ascend 路径。Issue #43549 明确要求在主文档中增加一个简短的指向性入口,避免重复完整的安装说明。

建议合并。这是一项小而清晰的文档改进,遵循了既有的选项卡风格,且已通过审查和预览验证。合并后可关闭关联 Issue #43549。

讨论亮点

主要讨论集中在 typos 拼写检查报错上。robellliu-dev 指出 CANN 被 typos 钩子标记为错误,建议要么忽略该 token 要么修改措辞。PR 作者选择在 pyproject.toml 中添加 CANN 白名单,保持了文档原文。Yikun 提供了关于 note 结构简化的建议,但未被采纳。最终 Yikun 批准合并。

实现拆解

  1. 修改 quickstart.md:在 docs/getting_started/quickstart.md 的安装选项卡中,在“Apple Silicon (Mac)”之前新增一个“Ascend NPU”选项卡,内容包含指向 vllm-ascend 仓库、快速入门和文档的链接,并附注说明依赖硬件和 CANN 版本。
  2. 修改 pyproject.toml:在 [tool.typos.default.extend-words] 中添加 CANN 白名单,以避免 pre-commit 的 typos 钩子将 CANN 误报为拼写错误。
文件 模块 状态 重要度
docs/getting_started/quickstart.md 文档 modified 2.14
pyproject.toml 工具配置 modified 2.27

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

评论区精华

typos 拼写检查失败如何处理 other

robellliu-dev 指出 typos 钩子将 CANN 标记为错误,建议要么忽略该 token 要么修改措辞。PR 作者选择在 pyproject.toml 中添加白名单。

结论:在 pyproject.toml 的 extend-words 中添加 CANN,保持文档原文。 · 已解决

note 格式简化建议 设计

Yikun 建议简化 note 结构,只保留一个指向文档的链接。

结论:PR 作者未采纳该建议,最终合并版本保留了原始格式。 · unresolved

风险与影响

无技术风险。变更仅涉及文档和工具配置,未修改任何代码逻辑或运行时行为。CANN 白名单的添加仅影响 typos 工具的扫描结果,无安全隐患。

对用户:让使用 Ascend NPU 的用户能更便捷地从 vLLM 主文档找到对应的安装引导,提升文档的可发现性。对系统:无运行时影响。对团队:维护成本极低,后续若 Ascend 文档链接变更需同步更新。影响范围仅限于文档页面。

无运行时影响

关联 Issue

#43549 [Doc]: Mention Ascend NPU in the main quickstart

完整报告

参与讨论