| Files | Last commit | Last update |
|---|---|---|
[docs] 对外接口通信域入参补充有效性约束说明 Co-authored-by: renmengguang<renmengguang@h-partners.com> # message auto-generated for no-merge-commit merge: !5509 merge docs/issue-955-comm-input-constraint into master [docs] 对外接口通信域入参补充有效性约束说明 Created-by: ren-mengguang Commit-by: renmengguang Merged-by: cann-robot Description: ## 描述 带 comm 通信域入参的对外接口（如 HcclGetRankSize、HcclThreadAcquire、HcclRankGraphGetLayers 等）实现入口仅做空指针校验（返回 HCCL_E_PTR），无句柄有效性查表校验；传入野指针时接口内部判空通过后直接解引用，导致程序 coredump 而非返回错误码，且问题难以定位。 本 PR 对外接口资料侧补充统一的有效性约束，明确调用方需传入可用通信域指针： - 排查 include/ 下全部对外头文件，确定 comm 为输入参数的接口共 58 个，覆盖 hccl_comm.h（17）、hccl_res.h（12）、hccl_channel.h（6）、hccl_rank_graph.h（13）、hccl_team.h（4）、hccl_ccu_res.h（3，另有 HcclGetRankId/RankSize 两处复用页）；L3-prim/L3-res/CCU 接口入参为 thread/channel/endpoint 句柄，不在本范围。 - 为 58 个接口文档的「约束说明」章节补充统一约束：comm必须为有效的通信域句柄（由通信域创建接口获得，调用期间保持有效）。禁止传入空指针、野指针或已销毁的句柄。追加格式跟随各文档既有风格（bullet / 编号列表 / npu 注释块均保持原样）。 - HcclCommDestroy 按实际行为特化表述：传入的comm必须为未被销毁的有效通信域句柄，禁止传入野指针或已销毁的通信域句柄。 - HcclGetRankSize（comm_mgr_c 与 topo_info_query 两处）既有旧文案同步升级；HcclAicpuKernelLaunch 原"调用前需确保通信域已正确初始化"条目被统一约束覆盖替换。 纯文档变更，不涉及代码与头文件。 ## 变更类型 - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue #955 ## 测试 已完成的测试用例和场景： 1. pre-commit（clang-format/OAT）本地校验通过，改动文件 0 违规。 2. 全量覆盖核查：58 个带 comm 入参的接口文档 100% 包含新约束（反查仅剩无 comm 入参的 HcommMemAlloc/HcommMemFree 等接口，符合预期）。 3. diff 逐文件核查：删除行均为预期的旧行替换（"无"、旧文案、旧初始化条目），无误删；markdown 结构校验（列表标记、前后空行、npu 注释块）0 问题。 4. 文案精简后重新全量校验：纯文案行替换，冗长文案零残留，markdown 结构与 pre-commit 复验通过。 补充的UT用例： NA（纯资料变更，无代码逻辑改动） ## 文档更新 本 PR 即文档更新：docs/zh/api_ref/ 下 58 个接口文档。 ## 合入检查 - [x] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [x] 🔍 邀请 committer评论/lgtm前的必要检查 - [x] 🏷️ 标题中使用了合适的类型标签（[docs]） - [x] 📄 代码修改内容已简要描述，相关文档已更新 - [x] 📝 代码注释已更新，代码遵循项目整体代码风格 - [ ] 🧪 代码UT测试已更新，覆盖率已达标 - [x] 🔬 验证方法已更新到"测试"部分 - [x] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!5509 | 1 month ago | |
[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 | |
[docs] 统一CCU接口文档术语为Event/Variable/Address/CcuBuffer/片上内存 | 1 month ago | |
[fix docs] 修改md文件名称，删除aicpu算子开发中冗余图片 Co-authored-by: zangyan<zangyan@huawei.com> # message auto-generated for no-merge-commit merge: !4096 merge master into master [fix docs] 修改md文件名称，删除aicpu算子开发中冗余图片 Created-by: flyswa Commit-by: zangyan Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 1、修改头文件与库文件介绍文件的名称，避免上昇腾社区冲突。 2、删除AI CPU算子开发中未被冗余的图片，另外调整原有图片大小，避免图片过大，影响视觉。 3、调整文档格式，使其更加规范。 ## 变更类型 请选择本次引入的变更类型： <!-- [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!4096 | 3 months ago | |
docs: add CCU Variable/Event acquire API reference Co-authored-by: ting010<zhangting199@huawei.com> # message auto-generated for no-merge-commit merge: !4515 merge master into master docs: add CCU Variable/Event acquire API reference Created-by: ting010 Commit-by: ting010 Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> ## 变更类型 请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug修复 - [ ] ✨ 新特性 - [ ] 🚀 性能优化 - [ ] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的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!4515 | 2 months ago |
HCOMM API总览
- 对外头文件与库文件说明：列举HCOMM正式对外的头文件与库文件，供通信库/算子开发与部署参考。
- 通信域创建与管理接口（C语言）：用于实现单算子模式下的框架适配，实现分布式能力。
- 通信域创建与管理接口（Python语言）：用于实现图模式下的框架适配，当前仅用于TensorFlow网络在NPU执行分布式优化。
- 通信算子开发接口：提供控制面接口与数据面接口，支撑开发者自定义通信算子。