Pull Request已成功合入, 合并人@CANN-robot
(感谢 qixingkai 的贡献)变更摘要
此 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目录下的示例代码进行了相应的标点和描述问题修正,保持示例与文档的一致性。


代码审查
关闭概要
本次审查覆盖了全部 36 个变更文件。发现 4 个问题:
-
P2(2个):
内置数据类型-144.md第70-71行:unsigned long/signed long位宽从32bit改为64bit,与内置数据类型-139.md(保持32bit)矛盾。编程模型-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 |
💬 仅评论


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
/approveor/lgtm- Commenting
/approveimplies 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. 👍


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的社区贡献。


/compile


流水线任务触发成功
任务链接 [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执行结束


流水线任务触发成功
任务链接 [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执行结束


🟡 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) |


🟡 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 数学表达式(如"定义的浮点数值")。但在 内置宏-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 | |


描述
修改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
类型标签