已合并
doc:SIMT资料问题修改 #4223
qixingkai创建于 7月9日
doc:SIMT资料问题修改 #4223
已合并
qixingkai创建于 7月9日
qixingkai
qixingkai成员
7月9日

描述

修改SIMT样例资料,API资料,编程资料中存在标点符号,描述错误等问题

关联的Issue

测试

文档更新

更新的资料如下:
docs/api/SIMT-API/SIMD与SIMT混合编程简介
docs/guide/入门教程/快速入门/基于SIMT编程
docs/guide/算子实践参考/SIMT算子性能优化
docs/guide/算子实践参考/SIMT算子实现
docs/guide/编程指南/编程模型/AI-Core-SIMT编程
examples/03_simt_api

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 qixingkai 的贡献)
qixingkaiqixingkai成员
7月9日 创建了 pull request,commit 0599ebeb
atomgit-bot
atomgit-bot
7月9日 评论:

变更摘要

此 PR 主要对 SIMT 相关的文档资料和示例代码进行了修正,涉及 API 资料、编程指南、入门教程和算子实践参考等文档中的标点符号错误、描述不准确等问题,属于纯文档类更新。

主要改动

  • 标点符号修正:对 docs/api/SIMT-API/SIMD与SIMT混合编程简介、docs/guide/入门教程/快速入门/基于SIMT编程、docs/guide/算子实践参考/SIMT算子性能优化、docs/guide/算子实践参考/SIMT算子实现、docs/guide/编程指南/编程模型/AI-Core-SIMT编程 等文档中的标点符号使用进行了规范化修正。
  • 描述错误修复:修正了上述文档中存在的不准确或错误的表述,提升文档的准确性和可读性。
  • 示例资料更新:对 examples/03_simt_api 目录下的示例代码进行了相应的标点和描述问题修正,保持示例与文档的一致性。
likedislike
不准确?
atomgit-bot
atomgit-bot
7月9日 评论:

代码审查

关闭概要

本次审查覆盖了全部 36 个变更文件。发现 4 个问题:

  • P2(2个):

    1. 内置数据类型-144.md 第70-71行:unsigned long / signed long 位宽从32bit改为64bit,与 内置数据类型-139.md(保持32bit)矛盾。
    2. 编程模型-140.md 第105行:DataCache 公式缺少 min(…, 128KB) 上限,与同段落文字描述及已修复的 编程模型.md 不一致。
  • P3(2个):
    3. 编程模型-140.md 第88行:锚点链接改为 #调用,可能无法被文档渲染引擎正确解析。
    4. 编程模型.md 第86行:同上类问题。

其余 32 个文件未发现问题:API列表-148.md、内存空间限定符-143.md、内置变量-145.md、内置宏-146.md、函数执行空间限定符-142.md、核函数配置-147.md、API列表.md、内存空间限定符.md、内置宏.md、核函数配置.md、基础知识.md、算子实现.md、短向量类型提升效率.md、核函数.md(AI-Core-SIMT编程)、概述.md、线程架构.md、SIMT-BuiltIn关键字.md、SIMT语言扩展层C-API.md、抽象硬件架构.md、gather_1d/README.md、general_gather/README.md、profiling/README.md、profiling/README_en.md、msProf/README.md、torch_library_roll/README.md、memory_optimizations/README.md、memory_optimizations/README_en.md、aligned_types/README.md、matrix_transpose_practice/README.md、short_vector_add/README.md、execution_conf_optimizations/README.md、execution_conf_optimizations/README_en.md。

整体风险判断:中等。两份主要 API 参考文档之间存在数据不一致(long 位宽、DataCache 公式),可能导致开发者误解平台特性并编写错误代码。其余变更均为正向的标点、措辞、格式修正。

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

💬 仅评论

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

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
** ✅ ai_xin, wulinyu (2/2) ✅ ai_xin (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
7月9日 将zengjuan,zhanghao_0689,wulinyu,kong0808,dengjing_aoe,YeZZzzz1,bluesky901,yangbinhua,zhudi22,chenyiyuan,xun_zhuge,bianque,houyuyang,shi_nanxiang,wuyang_hw,jiangxinyu3,munanhw,ai_xin,ascendhjh,DragonBornHD84,hyolee,gcw_kUomxQ2l,Andy-lb设为评审人
CANN-robotCANN-robot成员
7月9日 将munanhw,ai_xin,gcw_kUomxQ2l,Andy-lb设为审查人
gao_dafa成员
7月9日 评论:

qixingkai,感谢您的提交,建议在完成PR充分自验证后,再触发线上构建任务。

若您的PR已具备检视条件,可根据下表的责任田,@对应的committer进行代码检视,我们会在第一时间对您的提交进行处理。

代码责任田:

module committer
adv_api chenyiyuan, wuyang_hw
basic_api chenyiyuan, wuyang_hw
c_api pangfd, haipingmao
cmake xun_zhuge, DragonBornHD84
docs munanhw, ai_xin
examples changxianyu, bianque
simt_api wulinyu, zhanghao_0689
scripts xun_zhuge, kevin365
tools YANXI_ZHAO, XuebinYang, sjtulxh

💡 如您不确定可以@谁,可以直接@我或者ascend-c sig的maintainer,xun_zhuge和ascendhjh,我们会为您分配合适的committer进行代码检视。

再次感谢您参与CANN的社区贡献。

likedislike
wulinyu成员
7月9日 评论:

/lgtm

likedislike
qixingkai
qixingkai成员
7月9日 评论:

/compile

likedislike
qixingkaiqixingkai成员
7月9日 预合并成功(commit_id: e5560da272e61b8b68d55eb9604d8c3a37570c1a)
CANN-robotCANN-robot成员
7月9日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月9日 评论:

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

任务名称状态日志下载链接
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS >>>>>
codecheck_Pr ✅ SUCCESS
pre_comment ✅ SUCCESS >>>>>
StaticCheck_codespell_check ⚠️ WARNING >>>>>
StaticCheck_link_validity_check ✅ SUCCESS
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>> >>>>>

[2026-07-09 20:54:26]    CI执行结束

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

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

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-09 20:54:44]    CI执行结束

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

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

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
UT_Test_adv_test_one ✅ SUCCESS
UT_Test_adv_test_two ✅ SUCCESS
UT_Test_basic_test_two ✅ SUCCESS
UT_Test_basic_test_three ✅ SUCCESS
UT_Test_basic_test_four ✅ SUCCESS
UT_Test_basic_test_five ✅ SUCCESS
UT_Test_arm ✅ SUCCESS
UT_Test_report ✅ SUCCESS >>>>>

[2026-07-09 20:55:36]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月9日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月9日 添加了label:ci-pipeline-passed
atomgit-bot
atomgit-bot7月9日进行代码检视1
docs/api/SIMT-API/SIMD与SIMT混合编程简介/编程模型-140.md
@@ -103,3 +103,3 @@
103103 
104104 ```
105- DataCache = UB总大小(256KB) – 静态内存 – 动态内存 – 预留空间(8KB)
105+ DataCache = UB总大小(256KB) - 静态内存 - 动态内存 - 预留空间(8KB)
atomgit-bot
atomgit-bot7月9日评论:

🟡 Medium Priority

在 docs/api/SIMT-API/SIMD与SIMT混合编程简介/编程模型-140.md 第102-105行,DataCache 计算公式仅做了格式修正(全角破折号→半角减号、空格清理),但未像 SIMT-only 的 docs/api/SIMT-API/SIMT编程简介/编程模型.md 第97行那样在公式中加入 min(..., 128KB) 上限。

两份文档的第102行和第94行均有相同的文字说明:"Data Cache最小为32KB,剩余空间超过128KB时Data Cache大小固定为128KB"。140.md的公式未体现此128KB上限,与文字描述矛盾,读者仅看公式可能误以为 DataCache 无上限。

触发条件:开发者仅参考140.md的公式而非文字描述来计算DataCache大小。

建议:将公式改为 DataCache = min(UB总大小(256KB) - 静态内存 - 动态内存 - 预留空间(8KB), 128KB),使其与同段落文字描述"剩余空间超过128KB时Data Cache大小固定为128KB"一致,也与已修复的编程模型.md对齐。

改动建议
105
- DataCache = UB总大小(256KB) - 静态内存 - 动态内存 - 预留空间(8KB)
105
+ DataCache = min(UB总大小(256KB) - 静态内存 - 动态内存 - 预留空间(8KB), 128KB)
应用建议
likedislike
不准确?
atomgit-bot
atomgit-bot7月9日进行代码检视1
docs/api/SIMT-API/SIMD与SIMT混合编程简介/扩展语法/内置宏-146.md
@@ -45,30 +30,30 @@
45-| ASCRT_LN2_F | 定义ln(2)的浮点数值。 | math_constants.h |
46-| ASCRT_LNT_F | 定义ln(10)的浮点数值。 | math_constants.h |
47-| ASCRT_LNPI_F | 定义ln(π)的浮点数值。 | math_constants.h |
48-| ASCRT_TWO_TO_M126_F | 定义2-126的浮点数值。 | math_constants.h |
49-| ASCRT_TWO_TO_126_F | 定义2126的浮点数值。 | math_constants.h |
30+| ASCRT_SQRT_HALF_F | 定义$\sqrt{1/2}$的浮点数值。 | math_constants.h |
31+| ASCRT_SQRT_HALF_HI_F | 定义$\sqrt{1/2}$的高位部分浮点数值。 | math_constants.h |
32+| ASCRT_SQRT_HALF_LO_F | 定义$\sqrt{1/2}$的低位部分浮点数值。 | math_constants.h |
33+| ASCRT_SQRT_TWO_F | 定义$\sqrt{2}$的浮点数值。 | math_constants.h |
34+| ASCRT_THIRD_F | 定义$1/3$的浮点数值。 | math_constants.h |
35+| ASCRT_PIO4_F | 定义$\pi/4$的浮点数值。 | math_constants.h |
36+| ASCRT_PIO2_F | 定义$\pi/2$的浮点数值。 | math_constants.h |
37+| ASCRT_3PIO4_F | 定义$3\pi/4$的浮点数值。 | math_constants.h |
38+| ASCRT_2_OVER_PI_F | 定义$2/\pi$的浮点数值。 | math_constants.h |
39+| ASCRT_SQRT_2_OVER_PI_F | 定义$\sqrt{2/\pi}$的浮点数值。 | math_constants.h |
40+| ASCRT_PI_F | $\pi$的浮点数值。 | math_constants.h |
41+| ASCRT_L2E_F | 定义$\log_2(e)$的浮点数值。 | math_constants.h |
42+| ASCRT_L2T_F | 定义$\log_2(10)$的浮点数值。 | math_constants.h |
43+| ASCRT_LG2_F | 定义$\log_{10}(2)$的浮点数值。 | math_constants.h |
44+| ASCRT_LGE_F | 定义$\log_{10}(e)$的浮点数值。 | math_constants.h |
45+| ASCRT_LN2_F | 定义$\ln(2)$的浮点数值。 | math_constants.h |
46+| ASCRT_LNT_F | 定义$\ln(10)$的浮点数值。 | math_constants.h |
47+| ASCRT_LNPI_F | 定义$\ln(\pi)$的浮点数值。 | math_constants.h |
48+| ASCRT_TWO_TO_M126_F | 定义$2^{-126}$的浮点数值。 | math_constants.h |
49+| ASCRT_TWO_TO_126_F | 定义$2^{126}$的浮点数值。 | math_constants.h |
5050| ASCRT_NORM_HUGE_F | 定义float类型的最大有限值,超过该值即溢出到inf。 | math_constants.h |
5151| ASCRT_TWO_TO_23_F | 定义223的浮点数值。 | math_constants.h |
5252| ASCRT_TWO_TO_24_F | 定义224的浮点数值。 | math_constants.h |
@@ -54,4 +54,4 @@
5454| ASCRT_TWO_TO_32_F | 定义232的浮点数值。 | math_constants.h |
atomgit-bot
atomgit-bot7月9日评论:

🟡 Medium Priority

本 diff 在 内置宏.md(SIMT编程简介)中将 ASCRT_TWO_TO_23_F、ASCRT_TWO_TO_24_F、ASCRT_TWO_TO_31_F、ASCRT_TWO_TO_32_F 四个宏的描述从旧版错误描述(如"定义223的浮点数值")更新为正确的 LaTeX 数学表达式(如"定义2232^{23}的浮点数值")。但在 内置宏-146.md(SIMD与SIMT混合编程简介)中,同样的四个条目(第 51-54 行)未被更新,仍保留旧的错误描述。

变更行:内置宏-146.md 第 51-54 行在 diff 中显示为未变更的上下文行(无 +/- 前缀),而 内置宏.md 第 51-54 行明确显示为已修改(有 -/+ 前缀)。

影响:两个文档对同一组常量的描述不一致,且文件 1 中四个常量的描述仍然不准确("223" 无法传达 2^23 的含义),可能误导参考该文档的开发者。

建议:将第 51-54 行修改为与内置宏.md 相同的 LaTeX 格式描述,使两个文档保持一致。

改动建议
54
+ | ASCRT_TWO_TO_23_F | 定义$2^{23}$的浮点数值。 | math_constants.h |
55
+ | ASCRT_TWO_TO_24_F | 定义$2^{24}$的浮点数值。 | math_constants.h |
56
+ | ASCRT_TWO_TO_31_F | 定义$2^{31}$的浮点数值。 | math_constants.h |
54
- | ASCRT_TWO_TO_32_F | 定义232的浮点数值。 | math_constants.h |
57
+ | ASCRT_TWO_TO_32_F | 定义$2^{32}$的浮点数值。 | math_constants.h |
应用建议
likedislike
不准确?
ai_xin成员
7月10日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月10日 添加了label:lgtmapproved
CANN-robotCANN-robot成员
7月10日 解决了最后一个问题
CANN-robotCANN-robot成员
7月10日 合入了pull request