master

cann-robot[docs] update pre-commit-guide

a3992b99Add on Sep 18History

Files	Last commit	Last update
aclgraph	[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	2 months ago
api_ref	[docs] 添加ccu loopgroup构造约束 Co-authored-by: gcw_7BxPXy6M<luoxiangyong1@huawei.com> # message auto-generated for no-merge-commit merge: !5444 merge lxy into master [docs] 添加ccu loopgroup构造约束 Created-by: gcw_7BxPXy6M Commit-by: gcw_7BxPXy6M Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue NA ## 测试 NA ## 文档更新 更新了docs/zh/api_ref/comm_opdev/data_plane_api/ccu/execution_control/LoopGroup.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!5444	1 month ago
architecture	[feat] ub建链 jetty 超时环境变量配置 以及档位修正1s->4s Co-authored-by: sqw<shiqiwen@huawei.com> # message auto-generated for no-merge-commit merge: !4357 merge ub_env_modify into master [feat] ub建链 jetty 超时环境变量配置 以及档位修正1s->4s Created-by: sqw Commit-by: sqw Merged-by: cann-robot Description: ## 描述 - 新增 config_mgr 模块 ：独立于 legacy EnvConfig 的环境变量解析模块，支持 HCOMM_TA_CTP_UB_TIMEOUT 、 HCOMM_TA_RTP_UB_TIMEOUT 、 HCOMM_TA_RTP_UBOE_TIMEOUT 三个环境变量；删除 HCCL_UBOE_TIMEOUT 和 HCCL_UB_TIMEOUT 的 环境变量解析模块 - DevUbConnection 构造函数新增 taTimeOut 参数 ：调用方按协议从环境变量获取后传入 - 新增 TpManager::CalcTaTimeOut 静态方法 ：从 GetTimeOut() 中提取的公共逻辑，计算 Jetty 异步创建超时挡位 - GetTimeOut() 简化 ： GetTimeOut() 改为调用 CalcJettyTimeOut - TA_TIMEOUT_MS_GEAR1 修正 ：1000ms → 4000ms，对齐硬件 errTime 挡位映射 - Channel 层适配 ：channel 文件按协议读取环境变量后传入 taTimeOut - Stub 适配 ： llt_next_orion_stub.cc 新增 CalcTaTimeout 等 stub 实现； llt_next_hccp_stub.cc 新增 HrtRaGetTpAttr stub - 变更点：TA_TIMEOUT_MS_GEAR1 修正说明：旧值 1000ms 与硬件实际超时不符，修正为 4000ms 对齐硬件行为。 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [x] ✨ 新特性 - [ ] 🚀 性能优化 - [ ] 📝 文档更新 - [x] 📋 其他，请描述： ## 测试 - TpManager UT（ut_tp_manager.cc，18 个用例） CalcTaTimeout 共 7 个用例。CalcTaTimeout 共 7 个用例。TP 协议场景 ：默认值大于等于 TP 总超时返回 16；8000ms 边界相等触发升挡返回 24；默认值小于 TP 总超时升挡返回 24；无效 at gear 为 5 回退默认 16。 CTP 协议场景 ：CTP 跳过 GetTpTotalTimeout 和比较逻辑，三个用例（含默认值大于等于、边界、默认值小于 TP 总超时）均直接返回默认 8。 CalcTaTimeout 共 10 个用例。CTP 协议场景：未传入 taTimeOut 返回默认 8；传入 16 返回 16；边界 4000ms 相等时直接返回 8。TP 协议场景：未传入且 env 大于等于 tp 返回 16；未传入且 env 小于 tp 升挡返回 24；传入 24 且 env 大于等于 tp 返回 24；传入 0 且 env 小于 tp 升挡返回 24；边界 8000ms 相等触发升挡返回 24。UBOE 协议场景：未传入且 env 小于 tp 升挡返回 24。UBG 协议场景：传入 24 且 env 大于等于 tp 返回 24。 FindMinTaHwValue 极端边界 1 个用例：0ms 返回 0，1ms 返回 0，511ms 返回 0，513ms 返回 8。 - DevUbConnection UT（ut_dev_ub_connection.cc，1 个用例） GetTimeOut 的 INVALID 异常路径：构造 DevUbConnection 后将 tpProtocol 设为 INVALID，打桩 ThrowAbnormalStatus 避免进程 abort，调用 GetTimeOut 后验证 status 被设为 CONN_INVALID。 - ConfigMgr UT（ut_config_mgr.cc，16 个用例，全部新增） HCOMM_TA_CTP_UB_TIMEOUT 共 6 个用例：未设置环境变量返回默认 8；合法值 0 返回 0；合法值 31 返回 31；非法值 32 超过范围回退默认 8；非法字符串 abc 回退默认 8；空字符串回退默认 8。 HCOMM_TA_RTP_UB_TIMEOUT 共 5 个用例：未设置返回默认 16；合法值 0 返回 0；合法值 31 返回 31；非法值 32 回退默认 16；负数 -1 回退默认 16。 HCOMM_TA_RTP_UBOE_TIMEOUT 共 5 个用例：未设置返回默认 16；合法值 0 返回 0；合法值 31 返回 31；非法值 100 回退默认 16；非法字符串 xyz 回退默认 16。 ST 用例（st_tp_manager.cc，18 个用例） 与 UT 对称的 ST 用例，覆盖 CalcTaTimeout 7 个、CalcJettyTimeOut 10 个、FindMinTaHwValue 极端边界 1 个，场景与 UT 完全一致。 ### 补充的 UT 用例 针对提交原始代码的完备性缺口，额外补充了三类 UT 用例。高优先级补充了 ConfigMgr 环境变量解析模块的 16 个用例，覆盖三个环境变量的合法值、非法值、默认值和边界值场景，新建 ut_config_mgr.cc 文件。中优先级补充了 DevUbConnection::GetTimeOut 的 INVALID 协议异常路径 1 个用例，验证 ThrowAbnormalStatus 被触发且 status 设为 CONN_INVALID。低优先级补充了 FindMinTaHwValue 的极端边界 1 个用例，覆盖 0ms、1ms、511ms、513ms 场景。 以上测试合计 57 个用例，覆盖了 CalcTaTimeout、CalcJettyTimeOut、ConfigMgr 环境变量解析、DevUbConnection 异常路径、HostUbConnection 构造函数、FindMinTaHwValue 极端边界等全部新增和修改接口。 ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论/lgtm前的必要检查 - [x] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [ ] 📄 代码修改内容已简要描述，相关文档已更新 - [ ] 📝 代码注释已更新，代码遵循项目整体代码风格 - [x] 🧪 代码UT测试已更新，覆盖率已达标 - [ ] 🔬 验证方法已更新到"测试"部分 - [ ] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [x] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!4357	2 months ago
build	[docs] update pre-commit-guide Co-authored-by: ouyangcaike<ouyangcaike@h-partners.com> # message auto-generated for no-merge-commit merge: !5126 merge docs/pre-commit into master [docs] update pre-commit-guide Created-by: ouyangcaike Commit-by: ouyangcaike Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 1. 更新 pre-commit 指导手册 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> NA ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> 已完成的测试用例和场景： 1. 编译成功 补充的UT用例： NA ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 1. 更新了 pre-commit-guide.md 文件 ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [x] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [x] 🔍 邀请 committer评论/lgtm前的必要检查 - [x] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [x] 📄 代码修改内容已简要描述，相关文档已更新 - [x] 📝 代码注释已更新，代码遵循项目整体代码风格 - [x] 🧪 代码UT测试已更新，覆盖率已达标 - [x] 🔬 验证方法已更新到"测试"部分 - [x] 🛠️ 代码已通过静态分析工具检查，无错误 - [x] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [x] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [x] 🚀 预约 前冒烟 用例前的必要检查 - [x] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [x] 🔧 代码已通过compile，编译无错误，无告警 - [x] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [x] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [x] 📊 前冒烟 用例已全量通过 - [x] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!5126	1 month ago
comm_op_dev_guide	[modify docs]修改产品型号名称 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !5425 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!5425	1 month ago
error_codes	EI0005 optimize Co-authored-by: liuwanke152<liuwanke1@hisilicon.com> # message auto-generated for no-merge-commit merge: !5170 merge master into master EI0005 optimize Created-by: liuwanke152 Commit-by: liuwanke152 Merged-by: cann-robot Description: ## 描述 errorMsg EI0005描述语义不清晰，优化EI0005描述并增加solution建议 ## 变更类型 请选择本次引入的变更类型： - [ ] 📝 文档更新 ## 关联的Issue ## 测试 构造EI0005异常，打印内容符合预期 补充的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!5170	2 months ago
rfcs	fix：host网卡插件rfc文档修改 Co-authored-by: gengxudong<gxdjsnt@sina.com> # message auto-generated for no-merge-commit merge: !5115 merge gxd_09 into master fix：host网卡插件rfc文档修改 Created-by: gxdjsnt Commit-by: gengxudong Merged-by: cann-robot Description: ## 描述 修改rfc中插件需要实现的ops表对应的API，增加了插件独立编译示例 ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [x ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [ ] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> ## 测试 插件示例可独立编译生成so ## 文档更新 更新了docs/zh/rfcs/0002-host-nic-plugin.md文档 See merge request: cann/hcomm!5115	2 months ago