已合并
docs(fix): Repair the docs bug #7245
lyz0328创建于 5 天前
docs(fix): Repair the docs bug #7245
已合并
lyz0328创建于 5 天前
lyz0328
lyz0328成员
5 天前

修改说明

对 docs/zh/api 全量文档(718 个 md)做质量自检,并按自检结论修复以下文档问题。所有改动均为行级文本修正,不改变文档结构与章节内容。

产品支持情况与芯片标签

  • index_hiascend.md:补登记 3 个缺失文档——pypto-conv_backward_filter、SIMT-API 同步控制简介(synchronization_intro)、Warp函数简介(warp_intro),插入位置与各目录 index.md 的 toctree 顺序保持一致
  • pypto-conv.md:修复约束说明中 npu 标签 id4/id5 与产品支持情况章节重复的问题,改为 id10/id11,保证 id 在文件内唯一
  • pypto-get_convbp_filter_tile_shapes.md / pypto-set_convbp_filter_tile_shapes.md / pypto-conv_backward_filter.md:产品型号名标准化——Ascend 950PR/Ascend 950DT → Ascend 950PR&950DT系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品 → Atlas A3系列产品、Atlas A2 训练系列产品/Atlas A2 推理系列产品 → Atlas A2系列产品

术语规范

  • PyPto → PyPTO:pypto-assemble.md(3 处)、pypto-view.md(1 处)
  • TileShape 变体统一(tileshape / tile shape / Tile shape → TileShape):15 个文件、36 处
  • 存储单元名称补全(L1/L0A/L0B/L0C 单独使用 → L1 Buffer / L0A Buffer / L0B Buffer / L0C Buffer):16 个文件、41 处,含 move.md 小节标题 ### L1->L0A/L0B → ### L1 Buffer->L0A/L0B Buffer、matmul.md Kirin9050 切分约束段等

参数表规范

  • 参数说明表头统一:| 参数 | → | 参数名 |,共 319 个文件;仅替换参数说明章节内的表头行,sum.md 约束说明中的数据类型矩阵(| 参数 | dim=0 | dim=1 |)不属于参数表,保持不动

其他

  • 批量修改保持各文件原有行尾风格(仓内 CRLF/LF 混合),未引入行尾变化
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 lyz0328 的贡献)
lyz0328lyz0328成员
5 天前 创建了 pull request,commit aec535e8
atomgit-bot
atomgit-bot
5 天前 评论:

变更摘要

本 PR 是一次文档修复类变更,主要涉及 docs/zh/api 下的中文 API 参考文档。改动集中在两个方面:一是统一参数说明表格的表头写法,将 参数 统一为 参数名,覆盖 SIMD-API、Reg-API、SIMT-API 等大量算子文档;二是统一术语表述,为存储层级名补全 Buffer 后缀(如 L1 Buffer、L0A/L0B Buffer、L0C Buffer)、将“使能”统一为“启用”、将 Tile shape 统一为 TileShape。同时 docs/zh/api/index_hiascend.md 的目录补充了若干新增文档条目。

主要改动

  • 参数表表头统一为 参数名: 在 docs/zh/api/pro_api/SIMD-API/Reg-API、SIMD-API、SIMT-API 等目录的大量算子文档中,将“参数说明”表格首列表头由 参数 改为 参数名,仅表头文字调整,不影响参数内容与语义。
  • 存储层级术语补全 Buffer 后缀: 在 memory_data_movement/move.md、load.md、store.md、store_tile.md、cube_computation/matmul_mx_acc.md、resource_management/make_tile.md 等文档中,将 L1、L0A、L0B、L0C、UB 等写法统一为带 Buffer 的表述(如 L1 Buffer → L0A/L0B Buffer、L0C Buffer),并同步修正相关小节标题与约束说明中的措辞。
  • “使能”统一为“启用”: 在 basic_data_structures/ReluPreMode.md 的功能说明与枚举注释、move.md/store.md/store_tile.md 中 scale 参数说明、special_reg_access/set_saturation_flag.md 中 enable 参数说明等处,将“使能”改为“启用”,并同步调整“使能位”为“启用位”。
  • Tile shape 统一为 TileShape: 在 memory_data_movement/store.md、store_tile.md 的 NZ 搬运约束以及 transpose_and_element_access/set_validshape.md 的 shape 参数说明中,将 Tile shape 统一写作 TileShape。
  • API 目录条目补充: 在 docs/zh/api/index_hiascend.md 中新增 pypto.conv_backward_filter 算子入口,并为 SIMT-API 的同步控制、Warp 函数分组分别补充 synchronization_intro.md、warp_intro.md 简介页条目。
likedislike
不准确?
atomgit-bot
atomgit-bot
5 天前 评论:

代码审查

✅ 未发现问题

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
docs ✅ congqiannan, 尹杰 (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

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

likedislike
CANN-robotCANN-robot成员
5 天前 将xinweiliu,cam_bxh,dai-zhentao,lululu40888,shi-dingkun,gguuaanngg,codehjp423,gaoxiang618,wangzheng97,DCGDDD,syfeng,jason_yuan_ye,foundea,ym-HW,hw_zhangzhiqi,yinjie27_,congqiannan,zhangyuebing,tsungl4,gaoxingwang,zhiweiyuan,caodongdong,make_pto,zhoubotcam,linjiashu,wangbing110,WenboCodes设为评审人
CANN-robotCANN-robot成员
5 天前 将foundea,yinjie27_,linjiashu设为审查人
lyz0328lyz0328成员
5 天前 修改了pull request 的描述
lyz0328lyz0328成员
5 天前 关联了issue:[Documentation|文档反馈]: docs/zh/api 全量自检发现的文档规范问题及批量修复(芯片标签/术语/参数表头等 7 类)
lyz0328
lyz0328成员
5 天前 评论:

compile

likedislike
lyz0328lyz0328成员
5 天前 预合并成功(commit_id: e93efddc428dc7b4b8bf464bb7b957a87095813d)
CANN-robot
CANN-robot成员
5 天前 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
5 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
5 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
5 天前 添加了label:ci-pipeline-passed
Jie Yin成员
5 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
5 天前 添加了label:approved
congqiannan成员
4 天前 评论:

/lgtm

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