已合并
docs: 同步快速入门并修正文档示例 #4354
docs: 同步快速入门并修正文档示例 #4354
已合并
陈思创建于 21 天前
陈思
陈思成员
21 天前

描述

同步 ops-nn 与 ops-cv 相关文档更新,并根据 ops-math 仓现有实现做仓别适配,避免直接照抄其他算子仓中不适用于 math 仓的命令、目标和示例。

主要修改:

  • 更新贡献指南中的 Issue、SIG 评审、交付件及 PR/CI 流程说明。
  • 按 ops-math 的 AddExample 实际代码同步 QUICKSTART 示例、输入数据和输出说明。
  • 更新 Ascend 950 相关编译参数与 AddExample 产品支持说明。
  • 修复 TilingFunc 非 void 函数缺少成功状态返回的问题。
  • 修复编译命令中可选参数方括号导致无法直接执行的问题。
  • 修正 AddExample 调用示例中误用 mean 算子输出的问题。
  • 修复 Spack root 管理员配置误用 user scope 的问题。
  • 补齐跨平台迁移 Gather 示例中的变量来源、作用域及数据搬运接口。

适配说明:

  • 未引入 ops-nn 特有的 aclnnAddExampleTest
  • 未引入 ops-cv 特有的 lcann_cv_static
  • 保留 ops-math Simulator 场景所需参数。
  • QUICKSTART 中的 shape、变量名和输出格式以 ops-math 当前 AddExample 源码为准。

参考修改:

关联的Issue

无。

文档检测问题:1274、1275、1702、1707、1834、1924。

测试

  • 已对精确范围内 8 个文件执行 git diff --check,检查通过。
  • 已核对 QUICKSTART 示例与 ops-math AddExample 当前源码的 shape、变量名和打印格式。
  • 已核对修改范围,不包含 docs/zh/debug/op_debug_prof.md 及其他无关工作区改动。
  • 本次仅修改文档,未执行算子编译或运行测试。

文档更新

更新以下文档:

  • CONTRIBUTING.md
  • docs/QUICKSTART.md
  • docs/zh/debug/cann_sim.md
  • docs/zh/develop/aicore_develop_guide.md
  • docs/zh/develop/cross_platform_migration_guide.md
  • docs/zh/install/spack_quick_install.md
  • docs/zh/invocation/quick_op_invocation.md
  • examples/add_example/README.md

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 陈思 的贡献)
陈思陈思成员
21 天前 创建了 pull request,commit 3b8aa5c8
atomgit-bot
atomgit-bot
21 天前 评论:

变更摘要

本次 PR 主要将 ops-nn 与 ops-cv 仓库的文档更新同步到 ops-math 仓库,并根据 ops-math 实际实现进行仓别适配,避免照搬不适用于 math 仓的命令、目标和示例。改动覆盖贡献指南、快速入门示例、编译参数、Spack 配置以及跨平台开发方案等 9 个文件,同时修复了多处文档中的代码错误和格式问题。

主要改动

  • 同步贡献指南流程说明:更新 How_to_contribute.mdISSUE.mdREADME.md,修订 Issue 提交流程、SIG 评审机制、交付件要求及 PR/CI 流程描述,使其与当前开发流程一致。
  • 按 ops-math 实际源码修正 QUICKSTART:根据 AddExample 的实际实现同步 QuickStart.md 中的示例代码、输入数据 shape、变量名及输出格式,并移除 ops-nn 特有的 aclnnAddExampleTest 和 ops-cv 特有的 lcann_cv_static,保留 math 仓 Simulator 场景所需参数。
  • 修复 TilingFunc 返回值与编译命令格式:修复 TilingFunc 非 void 函数缺少成功状态返回的问题,以及编译命令中可选参数方括号导致命令无法直接执行的问题。
  • 修正 AddExample 调用示例与 Ascend 950 说明:将示例中误用的 mean 算子输出修正为 Add 算子输出,并更新 Ascend 950 相关编译参数及产品支持说明。
  • 修复 Spack 配置与跨平台迁移文档:在 Spack_conf.md 中修复 root 管理员配置误用 user scope 的问题,在 跨平台开发方案.md 中补齐 Gather 示例的变量来源、作用域及数据搬运接口说明。
likedislike
atomgit-bot
atomgit-bot
21 天前 评论:

代码审查

✅ 未发现问题

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
21 天前 评论:

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
*/*/README.md 陈娇, wangrui_ (2/2) 陈娇 (1/1)
repo-cann/ops-math 宋恺, wangrui_ (2/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

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

likedislike
CANN-robot
CANN-robot成员
21 天前 评论:

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
21 天前 将zhou-qilong,gitee-duhuiping,wangrui_,rxtfeng,loov1,zhangzijie,jia0liang,zl_hw,songkai111,gitcode-chenjiao,pingchuantang,llimwang,zhouwenfang,gubaocheng,andong_hw,wuyao51511,xuejinghui,zhanw_coding,caiwenwen设为评审人
CANN-robotCANN-robot成员
21 天前 将zhou-qilong,gitee-duhuiping,wangrui_,rxtfeng,loov1,zhangzijie,jia0liang,zl_hw,songkai111,gitcode-chenjiao,pingchuantang,llimwang,zhouwenfang,gubaocheng,andong_hw,wuyao51511,xuejinghui,zhanw_coding,caiwenwen设为审查人
陈思
陈思成员
21 天前 评论:

compile

likedislike
陈思陈思成员
21 天前 update merge request[project id: 7649531, iid: 4354, commit_id: 1b5f46c595e93a4dd13db53ffea79fadc7475e35] virtual merging success
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
21 天前 评论:

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

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ SUCCESS >>>>> >>>>>

[2026-07-30 21:08:53]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
21 天前 评论:

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

任务名称状态日志下载链接
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_precommit ✅ SUCCESS >>>>>

[2026-07-30 21:07:36]    CI执行结束

likedislike
陈思陈思成员
21 天前 update merge request[project id: 7649531, iid: 4354, commit_id: e3b7bfcf838ba6444485b09b80282ef06b0a313b] virtual merging success
陈思陈思成员
21 天前 强制推送  1 个提交:2086d02c-docs: 同步快速入门并修正文档示例
陈思陈思成员
21 天前 update merge request[project id: 7649531, iid: 4354, commit_id: 32d4a98428aba30d39d268b75fd1d84bbada97ce] virtual merging success
CANN-robotCANN-robot成员
21 天前 删除了label:cann-cla/yes
CANN-robotCANN-robot成员
21 天前 添加了label:cann-cla/yes
陈思
陈思成员
21 天前 评论:

compile

likedislike
陈思陈思成员
21 天前 update merge request[project id: 7649531, iid: 4354, commit_id: 4f68b0110e934b622a9593a57b6c7452244fdca0] virtual merging success
CANN-robotCANN-robot成员
21 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
21 天前 评论:

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

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_A5_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_9030_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ 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
UT_Test_harmony-infer-cpro-math ✅ SUCCESS

[2026-07-30 21:19:57]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
21 天前 评论:

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

任务名称状态日志下载链接
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_precommit ✅ SUCCESS >>>>>

[2026-07-30 21:11:09]    CI执行结束

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
21 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-passed
chenjiao成员
20 天前 评论:

/approve

likedislike
RuiWang_成员
20 天前 评论:

/lgtm

likedislike
songkai111成员
20 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
20 天前 添加了label:lgtmapproved
CANN-robotCANN-robot成员
20 天前 合入了pull request