已合并
docs: 完善环境部署文档的驱动与CANN安装说明 #4100
docs: 完善环境部署文档的驱动与CANN安装说明 #4100
已合并
於欣洁创建于 7月15日
於欣洁成员
7月15日

描述

完善环境部署文档 quick_install.md 的驱动与 CANN 安装说明:

  • 运行态依赖由“驱动与固件”修正为“驱动”,移除固件相关描述;
  • 将驱动安装细化为三步:
    1. 在《CANN快速安装》页面选择自己的产品系列、CPU架构、操作系统,安装方式选择“在线安装(Yum)”;
    2. 依次完成“配置用户属组”、“安装依赖&配源”、“安装NPU驱动”三个环节;
    3. 执行 npu-smi info 验证驱动是否安装成功。
  • 方式3 手动安装-场景2:安装入口由“CANN官网下载中心”统一改为引导《CANN快速安装》,并对齐选型描述(产品系列、CPU架构、操作系统)。

关联的Issue

测试

文档改动,无需功能测试;已本地核对渲染与措辞,确认“判断→安装→验证”流程通顺,各入口统一引导至《CANN快速安装》。

文档更新

更新了 docs/zh/install/quick_install.md。

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 於欣洁 的贡献)
於欣洁成员
7月15日 创建了 pull request,commit dabacca3
atomgit-bot
atomgit-bot
7月15日 评论:

变更摘要

本次变更对 docs/zh/install/quick_install.md 环境部署文档进行措辞修正,将运行态依赖描述中的"驱动与固件"统一改为"驱动",移除固件相关表述。改动覆盖"方式2 Docker"与"方式3 手动安装-场景1"两个安装场景下的标题和正文。

主要改动

  • 标题修正:将章节标题"安装驱动与固件(运行态依赖)"改为"安装驱动(运行态依赖)",去除"固件"字样。
  • 正文措辞修正:将正文中"驱动与固件是运行态依赖……完成驱动与固件安装"改为"驱动是运行态依赖……完成驱动安装",使文档描述与实际的运行态依赖范围保持一致。
likedislike
atomgit-bot
atomgit-bot
7月15日 评论:

代码审查

最终检查

针对本次变更进行收尾检查:

  1. 边界值:不适用,纯文档变更。
  2. 热点路径成本:不适用。
  3. 共位二次缺陷:已重新审视变更行及相邻行(第3行、第12行、第19行、第137行、第178行),确认不存在被遗漏的独立缺陷(如错误的值/索引/字段选取、颠倒的比较等)。

审查总结

优先级 数量
P0 0
P1 0
P2 1
P3 0
  • docs/zh/install/quick_install.md:发现 1 个问题(文档内部矛盾——移除"固件"表述不完整,导致顶部说明/Spack章节仍引用固件作为运行态依赖,与变更后的操作步骤不一致)。

总体风险评估:低风险。本次变更是文档改进,无安全风险、无破坏性命令、无可泄露的凭据。唯一的问题是部分更新导致文档内部存在矛盾描述,可能在用户按文档操作时产生困惑,建议在合并前或后续PR中同步更新文档其他位置以保持一致。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
CANN-robotCANN-robot成员
7月15日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7月15日 评论:

CLA Signature Pass

yu-xinjie62, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
7月15日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/ops-math 王林木, 冯彤, 宋恺 (3/2) 王林木 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

yu-xinjie62, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
7月15日 将zhou-qilong,wangrui_,rxtfeng,loov1,zhangzijie,jia0liang,zl_hw,songkai111,llimwang,gubaocheng,andong_hw,zhanw_coding设为评审人
此处折叠了10条事件消息 查看更多
於欣洁成员
7月15日 修改了pull request 的描述
於欣洁成员
7月15日 评论:

compile

likedislike
於欣洁成员
7月15日 update merge request[project id: 7649531, iid: 4100, commit_id: 059b3412439d2fa4a2c539930ebe40d86316d593] virtual merging success
CANN-robotCANN-robot成员
7月15日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月15日 评论:

流水线任务触发成功
任务链接 [af9a88f73cca41ccbb949d39f38d6b98][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_harmony-infer ✅ SUCCESS >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
UT_Test_experimental ✅ SUCCESS
UT_Test_kernel ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>
UT_Test_harmony-infer-chs-math ✅ SUCCESS

[2026-07-15 21:06:29]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月15日 评论:

流水线任务触发成功
任务链接 [1ccee3cc4af446fc8faa4f1d3e105d3d][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_Pr ✅ SUCCESS
StaticCheck_codespell ✅ SUCCESS
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-15 20:59:38]    CI执行结束

likedislike
於欣洁成员
7月15日 修改了pull request 的描述
CANN-robotCANN-robot成员
7月15日 添加了label:api-check-pass
CANN-robotCANN-robot成员
7月15日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月15日 添加了label:ci-pipeline-passed
FelixTang7成员
7月15日 评论:

/lgtm
/approve

likedislike
CANN-robot
CANN-robot成员
7月15日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐燕峰

likedislike
CANN-robot
CANN-robot成员
7月15日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐燕峰

likedislike
atomgit-bot
atomgit-bot7月15日进行代码检视1
docs/zh/install/quick_install.md
@@ -104,0 +105,4 @@
105+ 
106+ - 步骤1:在页面中选择自己的产品系列、CPU架构、操作系统,安装方式选择“在线安装(Yum)”。
107+ - 步骤2:按照页面指引依次完成“配置用户属组”、“安装依赖&配源”、“安装NPU驱动”三个环节。
108+ - 步骤3:执行`npu-smi info`,若能正常显示NPU设备信息,则说明驱动安装成功。
atomgit-bot
atomgit-bot7月15日评论:

🟡 Medium Priority

本次变更将"方式2 Docker"和"方式3 手动安装-场景1"中的"驱动与固件"修正为"驱动",意图移除固件作为运行态依赖的表述。但文档中以下位置仍将固件列为运行态依赖,未被同步更新:

  • 第3行:"确保已安装NPU驱动、固件和CANN软件"
  • 第12行(说明段落):"运行态...需安装驱动与固件、CANN toolkit包、CANN ops包"
  • 第19行(方式表格中Spack说明):"运行态需宿主机提前安装驱动与固件"
  • 第178行(方式4 Spack安装):"运行态仍需宿主机提前安装驱动与固件"

这造成文档内部矛盾:顶部说明引导用户安装驱动与固件,但变更后的操作步骤仅要求安装驱动。用户将无法确定固件是否实际需要安装,可能导致部署遗漏(若固件实际仍需)或多余操作(若固件已不需要)。

触发条件:任何按文档顺序阅读的用户都会先看到"需安装驱动与固件",然后进入具体步骤时发现只需安装驱动,产生认知冲突。

建议:需同步更新文档中所有仍将"固件"列为运行态依赖的位置,以确保文档一致性。具体应修改的位置包括:

  1. 第3行:移除"固件"或改为"驱动";
  2. 第12行:将"驱动与固件"改为"驱动";
  3. 第19行(Spack说明):将"驱动与固件"改为"驱动";
  4. 第178行(方式4 Spack):将"驱动与固件"改为"驱动"。

或者,如果固件在特定场景下确实仍是运行态依赖,则需要在文档中明确区分哪些场景需要固件、哪些不需要,而非简单移除。

likedislike
llimwang成员
7月16日 评论:

/approve

likedislike
CANN-robot
CANN-robot成员
7月16日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐燕峰

likedislike
CANN-robotCANN-robot成员
7月16日 添加了label:approved
rxtfeng成员
7月16日 评论:

/lgtm

likedislike
CANN-robot
CANN-robot成员
7月16日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐燕峰

likedislike
songkai111成员
7月16日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月16日 添加了label:lgtm
CANN-robot
CANN-robot成员
7月16日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐燕峰

likedislike
CANN-robotCANN-robot成员
7月16日 解决了最后一个问题
CANN-robotCANN-robot成员
7月16日 合入了pull request