已合并
修文档中废弃接口及原子操作相关错误描述 #6493
修文档中废弃接口及原子操作相关错误描述 #6493
已合并
GRJ_XIDUO创建于 9月29日
GRJ_XIDUO
GRJ_XIDUO成员
9月29日

描述

分支文档中已废弃或不存在接口的错误使用:

  • 删除中英文API选型、C API贡献指南和代码风格文档中关于_sync同步接口的失效说明及示例。
  • 将Reg矢量计算示例中的MASK_PATTERN_ALL、asc_adds和asc_muls替换为当前有效的PAT_ALL、asc_add_scalar和asc_mul_scalar。
  • 修正C API贡献指南中的接口声明路径和调用模式说明。

修复原子操作分类和样例支持范围:

  • 将SetStoreAtomicConfig、GetStoreAtomicConfig及对应C API归入标量原子操作,并补充标量原子操作与数据搬运随路原子操作的差异。
  • 补充set_atomic_deterministic_computation样例对Ascend 950PR/Ascend 950DT的支持说明。

修复data_copy_gm2l1中英文样例文档,将错误的asc_set_l0c2gm_config和quant_pre更正为样例实际使用的asc_set_l0c_copy_config和
quant_pre_addr。

关联的Issue

https://gitcode.com/cann/asc-devkit/issues/1812

测试

文档更新

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 GRJ_XIDUO 的贡献)
GRJ_XIDUOGRJ_XIDUO成员
9月29日 创建了 pull request,commit c876c88d
GRJ_XIDUOGRJ_XIDUO成员
9月29日 关联了issue:[Documentation|文档反馈]: 修复文档中废弃接口使用、原子操作分类及样例说明错误
atomgit-bot
atomgit-bot
9月29日 评论:

变更摘要

本 PR 为文档修正类改动,主要清理分支文档中已废弃或不存在的接口用法,并纠正原子操作分类与样例说明中的错误。文档侧删除了中英文 API 选型、C API 贡献指南和代码风格文档中关于 _sync 同步接口的失效说明与示例,将 Reg 矢量计算示例中的 MASK_PATTERN_ALL、asc_adds、asc_muls 替换为 PAT_ALL、asc_add_scalar、asc_mul_scalar,并修正 C API 贡献指南中的接口声明路径与调用模式描述。原子操作部分将 SetStoreAtomicConfig、GetStoreAtomicConfig 及其对应 C API 归入标量原子操作,补充标量原子操作与数据搬运随路原子操作的差异,并为 set_atomic_deterministic_computation 样例补充 Ascend 950PR/Ascend 950DT 支持说明。此外修正 data_copy_gm2l1 中英文样例文档,将 asc_set_l0c2gm_config 与 quant_pre 更正为样例实际使用的 asc_set_l0c_copy_config 与 quant_pre_addr。

主要改动

  • 移除 _sync 同步接口的失效说明与示例: 删除中英文 API 选型、C API 贡献指南和代码风格文档中关于 _sync 同步接口的描述及示例,避免文档继续引用已废弃接口。
  • 替换 Reg 矢量计算示例中的接口名: 将示例中的 MASK_PATTERN_ALL、asc_adds、asc_muls 分别更正为当前有效的 PAT_ALL、asc_add_scalar、asc_mul_scalar。
  • 修正原子操作分类与差异说明: 把 SetStoreAtomicConfig、GetStoreAtomicConfig 及对应 C API 归入标量原子操作,并补充标量原子操作与数据搬运随路原子操作之间的差异说明。
  • 补充样例支持范围: 为 set_atomic_deterministic_computation 样例增加对 Ascend 950PR/Ascend 950DT 的支持说明。
  • 更正 data_copy_gm2l1 样例文档中的接口与变量名: 将 asc_set_l0c2gm_config 和 quant_pre 更正为样例实际使用的 asc_set_l0c_copy_config 和 quant_pre_addr;同时修正 C API 贡献指南中的接口声明路径与调用模式描述。
likedislike
不准确?
atomgit-bot
atomgit-bot
9月29日 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
不准确?
CANN-robotCANN-robot成员
9月29日 添加了label:stat/needs-squash
CANN-robotCANN-robot成员
9月29日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
9月29日 评论:

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
docs ✅ munanhw, wuyang_hw (2/2) ✅ munanhw (1/1)
examples ✅ munanhw, wuyang_hw (2/2) ✅ munanhw (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
9月29日 将zengjuan,zhanghao_0689,suqwe,wulinyu,kong0808,dengjing_aoe,YeZZzzz1,bluesky901,yangbinhua,zhudi22,chenyiyuan,xun_zhuge,XuebinYang,sjtulxh,bianque,houyuyang,Lycheeeee,YANXI_ZHAO,chentianyu19,shi_nanxiang,wuyang_hw,jiangxinyu3,munanhw,ai_xin,ascendhjh,hujiawen_kaven,wangxiaozhi,DragonBornHD84,louyuxuan,changxianyu,hyolee,yukangchen设为评审人
CANN-robotCANN-robot成员
9月29日 将xun_zhuge,bianque,YANXI_ZHAO,munanhw,ai_xin,ascendhjh,changxianyu设为审查人
GRJ_XIDUO
GRJ_XIDUO成员
9月29日 评论:

compile

likedislike
GRJ_XIDUOGRJ_XIDUO成员
9月29日 预合并成功(commit_id: 9e34afb50c04291953483eca14b687b8e3c31a82)
CANN-robot
CANN-robot成员
9月29日 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
9月29日 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
9月29日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
9月29日 添加了label:ci-pipeline-passed
munanhw成员
9月30日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
9月30日 添加了label:approved
吴洋成员
9月30日 评论:

/lgtm
/approve

likedislike
CANN-robot
CANN-robot成员
9月30日 评论:

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

likedislike
CANN-robotCANN-robot成员
9月30日 添加了label:lgtm
CANN-robotCANN-robot成员
9月30日 合入了pull request