CANN/hccl Scatter算子接口文档

HcclScatter

【免费下载链接】hccl集合通信库（Huawei Collective Communication Library，简称HCCL）是基于昇腾AI处理器的高性能集合通信库，为计算集群提供高性能、高可靠的通信方案项目地址: https://gitcode.com/cann/hccl

产品支持情况

• Ascend 950PR/Ascend 950DT：支持
• Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
• Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
• Atlas 推理系列产品：不支持
• Atlas 训练系列产品：支持

[!NOTE]说明 针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，仅支持Atlas 800T A2 训练服务器、Atlas 900 A2 PoD 集群基础单元、Atlas 200T A2 Box16 异构子框。

功能说明

集合通信算子Scatter操作接口，将root节点的数据均分并散布至其他rank。

函数原型

HcclResult HcclScatter(void *sendBuf, void *recvBuf, uint64_t recvCount, HcclDataType dataType, uint32_t root, HcclComm comm, aclrtStream stream)

参数说明

返回值

HcclResult：接口成功返回HCCL_SUCCESS，其他失败。

约束说明

• 所有rank的recvCount、dataType、root均应相同。
• 全局只能有1个root节点。
• 非root节点的sendBuf可以为空。root节点的sendBuf不能为空。

调用示例

void *sendBuf = nullptr; void *recvBuf = nullptr; uint64_t sendCount = 8; uint64_t recvCount = 1; size_t sendSize = sendCount * sizeof(float); size_t recvSize = recvCount * sizeof(float); // 申请 Device 内存用于接收 Scatter 结果 ACLCHECK(aclrtMalloc(&recvBuf, recvSize, ACL_MEM_MALLOC_HUGE_ONLY)); // 在 root 节点，申请 Device 内存用于存放发送数据 if (device == rootRank) { ACLCHECK(aclrtMalloc(&sendBuf, sendSize, ACL_MEM_MALLOC_HUGE_ONLY)); } // 初始化通信域 uint32_t rankSize = 8; HcclComm hcclComm; HcclCommInitRootInfo(rankSize, &rootInfo, device, &hcclComm); // 创建任务流 aclrtStream stream; aclrtCreateStream(&stream); // 执行 Scatter，将通信域内 root 节点的数据均分并散布至其他 rank HcclScatter(sendBuf, recvBuf, recvCount, HCCL_DATA_TYPE_FP32, rootRank, hcclComm, stream); // 阻塞等待任务流中的集合通信任务执行完成 aclrtSynchronizeStream(stream); // 释放资源 aclrtFree(sendBuf); // 释放 Device 侧内存 aclrtFree(recvBuf); // 释放 Device 侧内存 aclrtDestroyStream(stream); // 销毁任务流 HcclCommDestroy(hcclComm); // 销毁通信域

【免费下载链接】hccl集合通信库（Huawei Collective Communication Library，简称HCCL）是基于昇腾AI处理器的高性能集合通信库，为计算集群提供高性能、高可靠的通信方案项目地址: https://gitcode.com/cann/hccl