已合并
修改公共文档的专项问题 #185
caiwenwen创建于 5 天前
修改公共文档的专项问题 #185
已合并
caiwenwen创建于 5 天前
caiwenwen成员
5 天前

描述

公共文档专项治理,修改之前用户反馈内容。

关联的Issue

https://gitcode.com/cann/ops-ras/issues/112

测试

文档更新

类型标签

  • [x ] 文档更新
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 caiwenwen 的贡献)
Ccaiwenwen成员
5 天前 创建了 pull request,commit 7937998b
atomgit-bot
atomgit-bot
5 天前 评论:

变更摘要

本 PR 以文档修正为主,围绕快速上手命令说明、广播与数据类型转换规则、量化介绍文件清理及算子接口文档链接修复展开:QUICKSTART 文档补充 --run_example 的 --vendor_name 参数与 ${soc_version} 取值对照;broadcast_relationship.md 重新表述维度合并判定规则;conversion_relationship.md 补充 ACL_COMPLEX32 及浮点/复数互转规则;删除根目录重复的 quant_mode_introduction.md;修正 op_api_list.md 中 aclnnMatmulAbftVerify 的文档链接。

主要改动

  • --run_example 命令格式与参数说明: 中英文 QUICKSTART 通用命令格式新增可选参数 --vendor_name=<自定义算子包名>,并将 <算子名>、<运行模式>、<包模式> 改为列表说明,明确该参数默认值为 custom。
  • ${soc_version} 产品取值对照: 中英文快速上手中补充产品名与 ${soc_version} 的对应关系,如 Atlas A2 取 ascend910b、Atlas A3 取 ascend910_93、Ascend 950PR&950DT 取 ascend950。
  • 广播维度合并规则澄清: 中英文 broadcast_relationship.md 将限制条件改写为“按轴逐段标记是否需要广播并合并相同标记的相邻轴”,并要求合并后总段数少于 6,同时以轴下标从 0 开始的示例重新解释报错与成功场景。
  • 数据类型转换规则更新: 中英文 conversion_relationship.md 在可互转类型中新增 ACL_COMPLEX32,补充浮点类型可转换为整型、复数类型可转换为浮点类型,并说明 ACL_COMPLEX32 目前仅支持与 ACL_FLOAT16 互转。
  • 接口文档链接与冗余文档整理: 修正中英文 op_api_list.md 中 aclnnMatmulAbftVerify 的指向路径,并删除根目录下重复的 quant_mode_introduction.md 文档。

🧩 本次 Review 已使用自定义 Skill:

likedislike
不准确?
atomgit-bot
atomgit-bot
5 天前 评论:

代码审查

✅ 未发现问题


🧩 本次 Review 已使用自定义 Skill:

likedislike
不准确?
CANN-robotCANN-robot成员
5 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
5 天前 评论:

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.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

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

Module Approval Details

module lgtm status approve status
repo-cann/ops-ras ✅ 柳宗谷, 陈兴宇 (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

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

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
5 天前 将FelixTang7,yu-xinjie62,yue-ma,zhou-qilong,rxtfeng,loov1,LiuZonggu,chenxingyu18,llimwang,gubaocheng设为评审人
CANN-robotCANN-robot成员
5 天前 将FelixTang7,yu-xinjie62,yue-ma,zhou-qilong,rxtfeng,loov1,LiuZonggu,chenxingyu18,llimwang,gubaocheng设为审查人
caiwenwen成员
3 天前 评论:

compile

likedislike
CANN-robotCANN-robot成员
3 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
3 天前 评论:

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

任务名称状态日志下载链接
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>

[2026-11-02 10:12:10]    CI执行结束

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

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

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test_ophost ✅ SUCCESS
UT_Test_opapi ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>

[2026-11-02 10:14:03]    CI执行结束

likedislike
CANN-robotCANN-robot成员
3 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
3 天前 删除了label:api-check-pass
CANN-robot
CANN-robot成员
3 天前 评论:

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

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_Pr ❌ FAILED
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>
likedislike
CANN-robotCANN-robot成员
3 天前 删除了label:ci-pipeline-running
此处折叠了6条事件消息 查看更多
CANN-robotCANN-robot成员
1 天前 添加了label:cann-cla/yes
caiwenwen成员
1 天前 评论:

compile

likedislike
CANN-robotCANN-robot成员
1 天前 删除了label:ci-pipeline-failed
CANN-robotCANN-robot成员
1 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
1 天前 评论:

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

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test_ophost ✅ SUCCESS
UT_Test_opapi ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>

[2026-11-03 15:48:52]    CI执行结束

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

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

任务名称状态日志下载链接
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>

[2026-11-03 15:47:50]    CI执行结束

likedislike
CANN-robotCANN-robot成员
1 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
1 天前 删除了label:api-check-pass
CANN-robot
CANN-robot成员
1 天前 评论:

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

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

[2026-11-03 15:49:23]    CI执行结束

likedislike
CANN-robotCANN-robot成员
1 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
1 天前 添加了label:ci-pipeline-passed
Ccaiwenwen成员
1 天前 修改了pull request 的描述
LiuZonggu成员
1 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
1 天前 添加了label:approved
Ccaiwenwen成员
1 天前 修改标题为 “修改公共文档的专项问题”,原标题为“fix ras2”
chenxingyu18成员
1 天前 评论:

/lgtm

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