已合并
[docs][9.2.0] 修复RFC与自定义算子样例的中英文文档问题 #3159
[docs][9.2.0] 修复RFC与自定义算子样例的中英文文档问题 #3159
已合并
DiJIa2.0创建于 9月16日
DiJIa2.0
DiJIa2.0成员
9月16日

描述

将master分支PR #3153的文档修复移植到9.2.0,修复中英文信息缺失、错误路径指引和渲染问题。

原PR:https://gitcode.com/cann/hccl/pull/3153

  • RFC 0002英文架构图使用原PR的英文PNG,保留组件、接口与回退关系,并同步中英文图题。
  • 补齐AllGather/ReduceScatter AIV中文安装信息及AIV/CCU英文测试源码位置,明确运行命令从仓库根目录开始执行,修正目录树与路径。
  • 修复P2P和AllGather AICPU中文验签说明的代码块缩进、日志冒号,以及ReduceScatter路径编号和英文拼写、冠词。
  • 统一样例目录树符号,将运行参数说明移出shell代码块,同步中英文pre-commit表格及OAT检查范围说明。

9.2.0适配说明:该分支尚无RFC 0003和recursive_executor模块,因此跳过原PR中对应的4份Markdown,不引入这些模块或文档。保留9.2.0已有的A2/A3(--aiv_arch=220)编译说明。本次将原PR的3个提交合并为1个提交,变更范围为16份Markdown及1张PNG。

关联的Issue

关联 #719:https://gitcode.com/cann/hccl/issues/719

与原PR共同修复该Issue中适用于9.2.0的文档问题。

测试

  • git diff --cached --check通过。
  • 对16份Markdown进行解析,围栏闭合及中英文配对检查通过。
  • 核验四组AIV/CCU中英文命令一致,公共测试源码路径存在。
  • 对比原PR与9.2.0移植结果,确认保留的修复完整,分支既有差异保持不变。
  • PNG解码、原PR文件SHA256一致性及相对引用检查通过。
  • pre-commit run --files <17个修改文件>通过;额外使用仓库scripts/oat_check.sh一次性检查全部17个文件,OAT通过。
  • 仅修改文档,未运行软件包构建、UT/ST或上板测试。

文档更新

更新RFC 0002、pre-commit指导和P2P/AllGather/ReduceScatter样例README,共16份Markdown,并移植原PR的1张英文PNG架构图。

类型标签

合入检查

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 DiJIa2.0 的贡献)
DiJIa2.0DiJIa2.0成员
9月16日 创建了 pull request,commit 9866d6e8
DiJIa2.0DiJIa2.0成员
9月16日 关联了issue:[Documentation|文档反馈]: 修复RFC和自定义算子样例中英文文档审计问题
atomgit-bot
atomgit-bot
9月16日 评论:

变更摘要

本 PR 将 master 分支 PR #3153 的文档修复移植到 9.2.0 分支,针对中英文信息缺失、错误路径指引和渲染问题进行修复,变更范围覆盖 16 份 Markdown 文档及 1 张英文 PNG 架构图。修复内容涉及 RFC 0002、pre-commit 指导以及 P2P/AllGather/ReduceScatter 样例 README,且为适配 9.2.0 分支现状,跳过了原 PR 中与 RFC 0003 和 recursive_executor 模块相关的 4 份文档。

主要改动

  • RFC 0002 架构图与图题同步:采用原 PR 的英文 PNG 架构图,保留组件、接口与回退关系,并同步中英文图题,修复架构图渲染及双语对应问题。
  • 补充 AIV/CCU 安装与测试路径说明:补齐 AllGather/ReduceScatter 的 AIV 中文安装信息及 AIV/CCU 英文测试源码位置,明确运行命令须从仓库根目录执行,并修正目录树与路径描述。
  • 修复 AICPU 验签说明格式:修正 P2P 和 AllGather 中文验签说明中的代码块缩进与日志冒号,以及 ReduceScatter 路径编号和英文拼写、冠词问题。
  • 统一文档格式与同步双语表格:统一样例目录树符号,将运行参数说明移出 shell 代码块,并同步中英文 pre-commit 表格及 OAT 检查范围说明。
  • 9.2.0 范围适配:保留 9.2.0 已有的 A2/A3(--aiv_arch=220)编译说明,不引入原 PR 中 RFC 0003 与 recursive_executor 模块相关内容。
likedislike
不准确?
atomgit-bot
atomgit-bot
9月16日 评论:

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

likedislike
不准确?
DiJIa2.0
DiJIa2.0成员
9月16日 评论:

/compile

likedislike
DiJIa2.0DiJIa2.0成员
9月16日 预合并成功(commit_id: 271f9e346dd6aa80a08dc6799d102d6c021e2bc0)
CANN-robotCANN-robot成员
9月16日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
9月16日 评论:

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 ✅ 钟宇, 臧燕, 颜业峰 (3/2) ✅ 臧燕, 颜业峰 (2/1)
docs/zh/rfcs ✅ 颜业峰, 钟宇 (2/2) ✅ 颜业峰 (1/1)
examples ✅ 颜业峰, 钟宇 (2/2) ✅ 颜业峰 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)
likedislike
CANN-robot
CANN-robot成员
9月16日 评论:

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
9月16日 将adum,leabclove,yanglianxiang2,flyswa,linyf950,yanzhenghang,chenliang267,claire8090,yanyefeng,zhongyu1,chenhao_,songmingyang,wenxuemin,yangshaohua,bz_lee,chenyia,zhangxp1030,silencesirius设为评审人
CANN-robotCANN-robot成员
9月16日 将leabclove,flyswa,claire8090,yanyefeng,wenxuemin,zhangxp1030设为审查人
CANN-robot
CANN-robot成员
9月16日 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
9月16日 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
9月16日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
9月16日 添加了label:ci-pipeline-passed
zangyan成员
9月16日 评论:

/approve

likedislike
zhongyu
zhongyu成员
9月16日 评论:

/lgtm

likedislike
philo
philo成员
9月16日 评论:

/approve

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