已合并
【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】docs: 补齐 examples 与根 README 目录索引 #1789
Jys.348创建于 7月6日
【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】docs: 补齐 examples 与根 README 目录索引 #1789
已合并
Pull Request已成功合入, 合并人@CANN-robot
（感谢 Jys.348 的贡献）
Jys.3487月6日 关联了issue：[Documentation|文档反馈]: 【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】 examples 总索引漏列 05_custom_ops_allgather 自定义 AllGather 样例目录，[Documentation|文档反馈]: 【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】 根 README 的 src/ops 目录树漏列 barrier 和 interface_graph_mode 实际源码目录
7月6日 关联了issue：[Documentation|文档反馈]: 【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】 examples 总索引漏列 05_custom_ops_allgather 自定义 AllGather 样例目录，[Documentation|文档反馈]: 【2026 HCCL通信库创新大赛-华北赛区】【嘻嘻嘻】 根 README 的 src/ops 目录树漏列 barrier 和 interface_graph_mode 实际源码目录
7月6日 添加了label：cann-cla/yes
CANN-robot
7月6日 评论：
7月6日 评论：
CANN-robot
7月6日 评论：
7月6日 评论：
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 |
|---|---|---|
| examples | ✅ 颜业峰, zhangxp1030 (2/2) | ✅ 颜业峰 (1/1) |
| repo-cann/hccl | ✅ 颜业峰, zhangxp1030 (2/2) | ✅ 颜业峰 (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CANN-robot7月6日 将leabclove,chengym,ccl_ligang,yanzhenghang,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,lilianlin_hw,zhuyiming3,ouyangxizi设为评审人
7月6日 将leabclove,chengym,ccl_ligang,yanzhenghang,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,lilianlin_hw,zhuyiming3,ouyangxizi设为评审人
CANN-robot7月6日 将leabclove,chengym,ccl_ligang,yanzhenghang,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,lilianlin_hw,zhuyiming3,ouyangxizi设为审查人
7月6日 将leabclove,chengym,ccl_ligang,yanzhenghang,yanyefeng,chenhao_,dingweiqin_57,songmingyang,wenxuemin,yangxiaoyuan,laodazhao1,chenke2026,zhongqin2020,bz_lee,Innoecho,chenyia,temper7620,zhangxp1030,lilin_137,lilianlin_hw,zhuyiming3,ouyangxizi设为审查人
atomgit-bot
7月6日 评论：
7月6日 评论：
变更摘要
本 PR 修复了 examples 与根目录 README 索引与实际目录结构不一致的问题，主要涉及两处缺失：一是 examples/README.md 和 examples/README_en.md 漏列了实际已存在的 05_custom_ops_allgather 自定义 AllGather 样例目录入口；二是根目录 README.md 和 README_en.md 中 src/ops 目录树漏列了 barrier 和 interface_graph_mode 两个参与构建的子目录。本次变更仅补充文档索引，共涉及 4 个 Markdown 文件，新增 12 行，不涉及源码逻辑。
主要改动
- 补充
05_custom_ops_allgather样例索引：在examples/README.md和examples/README_en.md中新增自定义集合通信算子章节，并添加05_custom_ops_allgather目录入口，使索引与实际样例目录结构一致。 - 补充
barrier和interface_graph_mode目录索引：在根目录README.md和README_en.md的src/ops目录树中补全barrier与interface_graph_mode两个子目录，与src/ops/CMakeLists.txt中的add_subdirectory构建配置保持一致。 - 中英文文档同步更新：所有变更均同步应用到中文版（
README.md、examples/README.md）和英文版（README_en.md、examples/README_en.md）。
atomgit-bot
7月6日 评论：
7月6日 评论：
Jys.348
7月9日 评论：
7月9日 评论：
/compile
7月18日 添加了label：ci-pipeline-running
CANN-robot
7月18日 评论：
7月18日 评论：
流水线任务触发成功
任务链接 [dc2590044b2244b8b7bf863acab197e6][流水线指导]
| 任务名称 | 状态 | 日志 | 下载链接 |
|---|---|---|---|
| SCA | ✅ SUCCESS | >>>>> | |
| antipoison | ✅ SUCCESS | >>>>> | |
| Check_Pr | ✅ SUCCESS | >>>>> | |
| pre_comment | ✅ SUCCESS | >>>>> | |
| Compile_Ascend_X86 | ✅ SUCCESS | >>>>> | >>>>> |
| Compile_Ascend_ARM | ✅ SUCCESS | >>>>> | >>>>> |
| Compile_Ascend_X86_ubuntu24 | ✅ SUCCESS | >>>>> | >>>>> |
| Compile_Ascend_ARM_ubuntu24 | ✅ SUCCESS | >>>>> | >>>>> |
| StaticCheck_codespell | ✅ SUCCESS | ||
| StaticCheck_link_validity | ✅ SUCCESS | ||
| StaticCheck_resource_existence | ✅ SUCCESS | ||
| StaticCheck_tag_closed | ✅ SUCCESS | ||
| StaticCheck_markdownlint | ✅ SUCCESS | ||
| Compile_Ascend_X86_monitor | ✅ SUCCESS | >>>>> | |
| Compile_Ascend_ARM_monitor | ✅ SUCCESS | >>>>> | |
| UT_Test | ✅ SUCCESS | >>>>> | |
| API_Check | ✅ SUCCESS | >>>>> | |
| ST_Test | ✅ SUCCESS | >>>>> | |
| codecheck | ✅ SUCCESS | >>>>> | |
| precommit | ✅ SUCCESS | >>>>> | |
| codecheck_codestyle | ✅ SUCCESS | >>>>> | |
| PreSmoke_A900_npupool | ✅ SUCCESS | >>>>> | |
| PreSmoke_A3_npupool | ✅ SUCCESS | >>>>> |
[2026-07-18 10:14:18] CI执行结束
7月18日 添加了label：api-check-pass
7月18日 删除了label：ci-pipeline-running
7月18日 添加了label：ci-pipeline-passed
CANN-robot
7月18日 评论：
7月18日 评论：
流水线 PR-pipeline_cann_hccl#5324 [ commitID：e8fe0a2a ] 已完成
philo
7月18日 评论：
7月18日 评论：
/approve
7月18日 添加了label：approved
zhangxp1030
7月18日 评论：
7月18日 评论：
/lgtm
7月18日 添加了label：lgtm
7月18日 关闭了关联的issue
7月18日 合入了pull request
描述
本 PR 修复 2 处 README 索引与实际目录结构不一致的问题：
examples/README.md、examples/README_en.md是 HCCL 样例代码总索引，但原文只列到04_custom_ops_p2p，漏列实际存在且已有独立说明文档的05_custom_ops_allgather自定义 AllGather 样例目录。本次补充自定义集合通信算子章节，并增加05_custom_ops_allgather入口。README.md、README_en.md的src/ops目录树漏列实际存在并参与构建的barrier和interface_graph_mode目录。本次在中英文目录树中补充这两个目录。变更类型
请选择本次引入的变更类型：
关联的Issue
关联Issue: #232
相关Issue: #233
测试
已完成的测试用例和场景：
examples/05_custom_ops_allgather/README.md与README_en.md均存在。src/ops/barrier、src/ops/interface_graph_mode目录均存在。src/ops/CMakeLists.txt已包含add_subdirectory(interface_graph_mode)和add_subdirectory(barrier)。git diff --check，未发现空白格式错误。补充的UT用例：
不涉及。本 PR 仅补充 README 文档索引，不改变源码逻辑。
文档更新
更新以下文档：
examples/README.mdexamples/README_en.mdREADME.mdREADME_en.md合入检查