| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Feat] add aclgraph introduction in docs Co-authored-by: zhiweihai_00958272<zhiweihai@huawei.com> # message auto-generated for no-merge-commit merge: !3106 merge aclgraphDocs into master [Feat] add aclgraph introduction in docs Created-by: Helmar Commit-by: zhiweihai_00958272 Merged-by: cann-robot Description: ## 描述 本次 PR 在 docs/zh/aclgraph/ 和 docs/en/aclgraph/ 下新增 ACL Graph（NPU 侧图捕获—重放机制）的完整技术文档（中英双语）及配套示例代码，并在 examples/02_aclgraphs/ 下新增 AllReduce 算子 ACL Graph 模式示例。具体改动如下： **1. 新增 ACL Graph 介绍文档（中英双语）** - docs/zh/aclgraph/aclgraph_introduction.md（中文版） - docs/en/aclgraph/aclgraph_introduction.md（英文版，runtime 文档链接引用 Ascend 官网英文版） 系统阐述 ACL Graph 的核心机制，覆盖：§1 ACL Graph 定位与适用范围、§2 捕获生命周期（4 步 API 流程 + 捕获前准备 + 跨流捕获约束 + 同步原语选型 + replay/销毁顺序）、§3 任务更新（原地更新 vs 重新捕获选型）、§4 已知失败模式与规避（启动期/捕获期/释放期）、§5 多 stream 拓扑（HCCL 内部控制面/数据面拆分），以及附录 A 关键 API 速查表、附录 B torch_npu 源码对接路径。文档中所有公开仓链接已逐一验证有效。 **2. 新增 5 张架构流程图** - aclgraph_cross_stream_capture.png（跨流捕获基本流程） - aclgraph_inplace_task_update.png（原地更新任务流程） - aclgraph_recapture_tasks.png（重新捕获任务流程） - aclgraph_concurrent_task_update.png（并发执行场景任务更新流程） - multi_streams_in_aclgraph.png（多 stream 拓扑全景） **3. 新增 AllReduce 算子 ACL Graph 模式示例代码** - examples/02_aclgraphs/allreduce_aclgraph_demo.cpp：原生 ACL + HCCL C API 实现，对应文档 §2.1 四步生命周期（CaptureBegin → HcclAllReduce → CaptureEnd → 多次 ExecuteAsync），已通过 clang-format v18.1.8 格式化。 - examples/02_aclgraphs/allreduce_aclgraph_demo.py：torch_npu.NPUGraph + torch.distributed(hccl) 实现，用 with torch.npu.graph(g): 上下文捕获计算 + dist.all_reduce，g.replay() 多次重放。 **改动原因**：ACL Graph 是 HCCL 通信在图模式下性能优化的关键机制，此前仓库缺少面向开发者的系统性文档。 ## 变更类型 请选择本次引入的变更类型： - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue NA ## 测试 无（纯文档变更，不涉及代码逻辑）。 补充的UT用例： 无（纯文档变更，不涉及代码逻辑）。 ## 文档更新 本次 PR 本身即为文档更新： - 新增 docs/zh/aclgraph/aclgraph_introduction.md（中文版 ACL Graph 完整技术文档） - 新增 docs/en/aclgraph/aclgraph_introduction.md（英文版 ACL Graph 完整技术文档） - 新增 examples/02_aclgraphs/allreduce_aclgraph_demo.cpp（C++ 示例） - 新增 examples/02_aclgraphs/allreduce_aclgraph_demo.py（Python 示例） ## 合入检查 - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论/lgtm前的必要检查 - [ ] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [x] 📄 代码修改内容已简要描述，相关文档已更新 - [x] 📝 代码注释已更新，代码遵循项目整体代码风格 - [x] 🧪 代码UT测试已更新，覆盖率已达标 - [x] 🔬 验证方法已更新到"测试"部分 - [x] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [x] 🔧 代码已通过compile，编译无错误，无告警 - [x] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 ## 其他信息 - 英文版文档中引用的 runtime 开发指南链接指向 Ascend 官网英文版（hiascend.com），而非 gitcode 中文版 - 附录 B 中 torch_npu 源码链接指向 github.com/Ascend/pytorch（原 Ascend/torch_npu 仓已更名为 Ascend/pytorch） - 源码行号已与 master 分支最新代码核对 See merge request: cann/hcomm!3106 | 1 个月前 | |
[Docs] 修改 build.md 中 json 链接错误 Co-authored-by: jiyuanhao<jiyuanhao1@huawei.com> # message auto-generated for no-merge-commit merge: !4940 merge docs/offline-compile into master [Docs] 修改 build.md 中 json 链接错误 Created-by: jiyuanhao Commit-by: jiyuanhao Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> [Docs] 修改 build.md 中 json 链接错误 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> 已完成的测试用例和场景： 1. 2. 补充的UT用例： ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论 /lgtm前的必要检查 - [ ] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [ ] 📄 代码修改内容已简要描述，相关文档已更新 - [ ] 📝 代码注释已更新，代码遵循项目整体代码风格 - [ ] 🧪 代码UT测试已更新，覆盖率已达标 - [ ] 🔬 验证方法已更新到"测试"部分 - [ ] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!4940 | 28 天前 | |
[modify docs]修正文档中英文不一致性问题 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !4700 merge master into master [modify docs]修正文档中英文不一致性问题 Created-by: flyswa Commit-by: zangyan Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 修正中英文文档不一致性问题，并补全部分英文文档。 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> 已完成的测试用例和场景： 1. 2. 补充的UT用例： ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论 /lgtm前的必要检查 - [ ] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [ ] 📄 代码修改内容已简要描述，相关文档已更新 - [ ] 📝 代码注释已更新，代码遵循项目整体代码风格 - [ ] 🧪 代码UT测试已更新，覆盖率已达标 - [ ] 🔬 验证方法已更新到"测试"部分 - [ ] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!4700 | 1 个月前 | |
[modify docs]修正文档中英文不一致性问题 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !4700 merge master into master [modify docs]修正文档中英文不一致性问题 Created-by: flyswa Commit-by: zangyan Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 修正中英文文档不一致性问题，并补全部分英文文档。 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> 已完成的测试用例和场景： 1. 2. 补充的UT用例： ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论 /lgtm前的必要检查 - [ ] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [ ] 📄 代码修改内容已简要描述，相关文档已更新 - [ ] 📝 代码注释已更新，代码遵循项目整体代码风格 - [ ] 🧪 代码UT测试已更新，覆盖率已达标 - [ ] 🔬 验证方法已更新到"测试"部分 - [ ] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!4700 | 1 个月前 |