Files	Last commit	Last update
control_plane_api	[docs] 统一CCU接口文档术语为Event/Variable/Address/CcuBuffer/片上内存	1 month ago
data_plane_api	[docs] 统一CCU接口文档术语为Event/Variable/Address/CcuBuffer/片上内存	1 month ago
datatype_definition	[docs] 统一CCU接口文档术语为Event/Variable/Address/CcuBuffer/片上内存	1 month ago
README.md	[fix docs]调整CCU资源管理的目录结构，优化空格问题 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !4373 merge master into master [fix docs]调整CCU资源管理的目录结构，优化空格问题 Created-by: flyswa Commit-by: zangyan Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 1、调整CCU资源管理目录结构 2、优化空格问题 3、修正HcclGetErrorString代码样例中devID未定义问题 ## 变更类型请选择本次引入的变更类型： <!-- [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!4373	3 months ago
_dump_node_ctrl.md	[fix docs]调整CCU资源管理的目录结构，优化空格问题 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !4373 merge master into master [fix docs]调整CCU资源管理的目录结构，优化空格问题 Created-by: flyswa Commit-by: zangyan Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 1、调整CCU资源管理目录结构 2、优化空格问题 3、修正HcclGetErrorString代码样例中devID未定义问题 ## 变更类型请选择本次引入的变更类型： <!-- [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!4373	3 months ago
_dump_node_data.md	[doc]修正 HCOMM/HCCL API 参考文档中的错误描述、不一致术语、示例代码缺陷，并同步新增枚举值与接口导航 Co-authored-by: Innoecho<sunzhepeng@huawei.com> # message auto-generated for no-merge-commit merge: !3580 merge fixDoc into master [doc]修正 HCOMM/HCCL API 参考文档中的错误描述、不一致术语、示例代码缺陷，并同步新增枚举值与接口导航 Created-by: Innoecho Commit-by: Innoecho Merged-by: cann-robot Description: ## 描述 ### 简要描述批量修正 HCOMM/HCCL API 参考文档中的错误描述、不一致术语与示例代码缺陷，并同步新增枚举值与接口导航。 ### 问题描述 API 参考文档（`docs/zh/api_ref/`）存在多类问题，影响开发者正确使用接口： - 参数表头术语不统一（"说明"/"描述"混用）。 - 返回值错误码命名错误（写成 `HcclSuccess` 而非枚举实际值 `HCCL_SUCCESS`）；部分控制面接口函数原型返回类型误写为 `HcclResult`（应为 `HcommResult`）。 - 示例代码存在编译/语义错误：C 代码误用 C++ 作用域符 `HcclCMDType::HCCL_CMD_SEND`；`HcclOpExpansionMode` 的 typedef 语法多余 `mode`；`HcommMemExport/HcommMemImport` 示例指针传参与变量初始化错误；`HcommThreadAlloc` 原型将数组形参写成标量；`HcommEndpointCreate/HcommMemReg` 示例用非法的 `{{192,168,1,100}}` 初始化 IP 地址；`HcclKernelLaunchCfg` 使用前未初始化。 - 约束说明有误：`HcommChannelDestroy` 错误描述为"原子操作"；多个接口列出了不存在的"支持的通信协议"约束。 - 数据类型注释与枚举名不一致（`float16/float32` vs `fp16/fp32`）。 - 枚举值文档落后于代码：`HcclResult` 缺 `HCCL_E_IN_STATUS`，`HcclOpExpansionMode` 缺 CCU 相关枚举值，`HcommThreadAlloc` 支持的通信引擎描述不全。 - 多个模块总览页（Python manage/split api、控制面/数据面入口、样例代码页）仅有标题、缺少接口列表与导航。 ### 解决方案 - 统一 C API 参数表头为"描述"。 - 修正返回值描述为 `HCCL_SUCCESS`；控制面接口原型返回类型统一为 `HcommResult`，成功返回值描述统一为"返回0表示成功"。 - 修正示例代码：`HCCL_CMD_SEND` 去作用域符；`HcclKernelLaunchCfgInit` 补初始化；`HcommThreadAlloc` 形参改为 `const uint32_t *notifyNumPerThread` 并同步示例；IP 地址改用 `inet_pton` 填充 `struct in_addr`；`HcommMemExport/HcommMemImport` 修正指针传参与变量命名/初始化；修复 `HcclOpExpansionMode` typedef 语法。 - 修正约束说明：`HcommChannelDestroy` 改为"逐个执行、非原子、不回滚"；删除无依据的"支持的通信协议"约束或改为"无"。 - 数据类型注释与枚举名对齐（`fp16/fp32`）。 - 同步枚举值：`HcclResult` 补 `HCCL_E_IN_STATUS = 1041`；`HcclOpExpansionMode` 补 `CCU_MS/CCU_SCHED/AIV_ONLY`；`HcommThreadAlloc` 功能说明补齐 AI CPU、HOST CPU 等引擎。 - 补充 Python manage/split api 模块、控制面/数据面入口、样例代码等总览页的接口列表与子模块导航。 ### 影响范围 - 新增：`HcclResult.HCCL_E_IN_STATUS`、`HcclOpExpansionMode` 三个 CCU/AIV 枚举值文档化；多个模块总览页接口列表与导航。 - 修改：75 个文件（`docs/zh/api_ref/` 下 C/控制面/数据面/Python API 文档）。 - 兼容性：仅文档与注释变更，不涉及 `src/`、`include/`、`pkg_inc/` 代码与 ABI，对编译与运行时行为无影响。 - 不影响架构分层、控制面/数据面分离及 HCCL↔HCOMM 解耦约束。 ### 新增用例 - 无（本次为文档与注释修正，未新增测试用例）。 ## 变更类型请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> NA ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> NA 补充的UT用例： ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 本pr仅更新文档，请参照修改文件列表 ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [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!3580	4 months ago

通信算子开发API