hccl/include · yevolin2023/hccl

cann-robotdocs: 补全14个算子接口文档返回值错误码、并发约束及AllGatherV/ReduceScatterV调用示例

文件	最后提交记录	最后更新时间
hccl.h	docs: 补全14个算子接口文档返回值错误码、并发约束及AllGatherV/ReduceScatterV调用示例 Co-authored-by: Leewis<liwei945@huawei.com> # message auto-generated for no-merge-commit merge: !2892 merge docs/api-return-concurrency-examples into master docs: 补全14个算子接口文档返回值错误码、并发约束及AllGatherV/ReduceScatterV调用示例 Created-by: Leewis Commit-by: Leewis Merged-by: cann-robot Description: ## 描述本 PR 对 HCCL 对外接口文档与头文件进行以下修改，覆盖 `hccl_api_problems.md` 中的 C1/C2/D1/B2/A2 问题项，Issue #673、Issue #670 的文档修复，扩展排查修复故障诊断目录其余故障码错配问题，并根据检视意见修正错误码表格与头文件注释。 ### 1. C1：14 个算子文档页返回值补全错误码列举将 14 个算子文档页的 `## 返回值` 节由泛指一句改为错误码表格，列举 `HCCL_SUCCESS`/`HCCL_E_PTR`/`HCCL_E_PARA`/`HCCL_E_NOT_SUPPORT`/`HCCL_E_INTERNAL` 及其触发条件。 ### 2. C2：HcclBatchSendRecv 头文件补 [@return](https://gitcode.com/return) 行 `include/hccl.h` 中 HcclBatchSendRecv 注释块缺失 `@return HcclResult` 行，现已补全。 ### 3. D1：14 个算子文档页补充并发约束在每个算子文档页的 `## 约束说明` 节末尾追加并发约束说明。 ### 4. B2：AllGatherV/ReduceScatterV 补调用示例两个文档页补全 `## 调用示例` 节。 ### 5. A2：头文件数据类型/操作类型列举统一改为指向接口文档将 `include/hccl.h` 中 13 个算子的 `@param` 注释里具体列举的数据类型和操作类型（共 20 处）统一替换为指向接口文档的说明。 ### 6. Issue #673：constraints.md 默认展开模式描述不一致 `constraints.md` 中 950 段默认展开模式由 `AI_CPU（默认值）` 更正为 `AICPU_TS（默认值）`。 ### 7. Issue #670：故障码显示文本与链接文件名不一致 `fault_diagnosis/` 下 4 处 `（EI0003）` 与 `_EI0019.md` 不一致，更正为 `（EI0019）`。同时删除 README 中"定位思路（EI0002）"多余的 EI0002 标注。 ### 8. 扩展排查：故障诊断目录其余故障码错配全量排查 `fault_diagnosis/` 目录，发现另有 4 处显示文本与链接文件名不一致，一并更正： - rank_table device_ip 字段校验失败：显示 `（EI0004）` → 更正为 `（EI0014）`（2 处） - TLS 信息配置不一致：显示 `（EI0014）` → 更正为 `（EI0016）`（2 处） ### 9. 根据检视意见修正根据检视人 yanzhenghang 的检视意见，修正 5 处错误码表格与头文件注释： - ReduceScatterV：HCCL_E_PTR 行移除 sendBuf，改为条件表述（实现不校验 sendBuf） - BatchSendRecv：补充 HCCL_E_PARA 行（实现中 CheckCount 和 HcomCheckUserRank 返回该码） - AllGatherV：HCCL_E_PTR 行改为条件表述（sendBuf 仅 sendCount>0 时校验，recvBuf 仅 recvCounts 非全 0 时校验） - Scatter：HCCL_E_PTR 行移除 stream（新路径 CheckScatterInputPara 不校验 stream） - hccl.h*：destRank/srcRank 补 `(u32)` 宽度标注，与同文件 root 参数风格一致 ## 关联的Issue - #673 - #670 - #691 - #671 - #672 ## 测试 - clang-format: Passed - OAT: 无新增问题 - GitCode 远端 Hooks: PASSED ## 文档更新本次 PR 仅涉及文档与头文件注释修改，不涉及代码逻辑变更。 ## 涉及文件清单 \| 文件 \| 修改内容 \| \|---\|---\| \| `include/hccl.h` \| C2 补 [@return](https://gitcode.com/return) 行 + A2 数据类型列举改为指向文档（20 处）+ 检视意见: destRank/srcRank 补 (u32) \| \| `docs/zh/api_ref/comm_op_interface/HcclAllReduce.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclBroadcast.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclReduce.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclAllGather.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclAllGatherV.md` \| C1 + D1 + B2 + 检视意见: HCCL_E_PTR 条件表述 \| \| `docs/zh/api_ref/comm_op_interface/HcclReduceScatter.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclReduceScatterV.md` \| C1 + D1 + B2 + 检视意见: HCCL_E_PTR 条件表述 \| \| `docs/zh/api_ref/comm_op_interface/HcclScatter.md` \| C1 + D1 + 检视意见: HCCL_E_PTR 移除 stream \| \| `docs/zh/api_ref/comm_op_interface/HcclAlltoAll.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclAlltoAllV.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclAlltoAllVC.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclSend.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclRecv.md` \| C1 + D1 \| \| `docs/zh/api_ref/comm_op_interface/HcclBatchSendRecv.md` \| C1 + D1 + 检视意见: 补 HCCL_E_PARA 行 \| \| `docs/zh/user_guide/constraints.md` \| Issue #673 \| \| `docs/zh/user_guide/fault_diagnosis/README.md` \| Issue #670 + 扩展排查 + 删除 EI0002 \| \| `docs/zh/user_guide/fault_diagnosis/_dump_cluster_info_nego.md` \| Issue #670 \| \| `docs/zh/user_guide/fault_diagnosis/_dump_param_link_stage.md` \| Issue #670 \| \| `docs/zh/user_guide/fault_diagnosis/_dump_rank_table_load_fail.md` \| 扩展排查 \| \| `docs/zh/user_guide/fault_diagnosis/_dump_cluster_info_verify_fail.md` \| 扩展排查 \| See merge request: cann/hccl!2892	12 天前
hccl_mc2.h	Modify the code standards Co-authored-by: unknown<huangjianbo3@h-partners.com> # message auto-generated for no-merge-commit merge: !2627 merge master into master Modify the code standards Created-by: muzhiyu6 Commit-by: unknown Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 1、修改代码格式规范 2、修复aiv 超时时间被截断的bug ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR不涉及Issue，可填写"NA"。--> https://gitcode.com/cann/hccl/issues/443 https://gitcode.com/cann/hccl/issues/442 https://gitcode.com/cann/hccl/issues/441 https://gitcode.com/cann/hccl/issues/439 https://gitcode.com/cann/hccl/issues/435 https://gitcode.com/cann/hccl/issues/434 https://gitcode.com/cann/hccl/issues/433 https://gitcode.com/cann/hccl/issues/431 https://gitcode.com/cann/hccl/issues/430 https://gitcode.com/cann/hccl/issues/429 https://gitcode.com/cann/hccl/issues/361 https://gitcode.com/cann/hccl/issues/359 https://gitcode.com/cann/hccl/issues/381 https://gitcode.com/cann/hccl/issues/567 https://gitcode.com/cann/hccl/issues/565 ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于构造对应xx测试用例、二级冒烟、算子泛化等。--> 1、代码review ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [ ] 文档更新 - [x] 其他，请描述：代码规范整改 See merge request: cann/hccl!2627	1 个月前