HcclAllReduce

产品支持情况

Ascend 950PR/Ascend 950DT：支持

Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持

Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持

Atlas 推理系列产品：支持

Atlas 训练系列产品：支持

功能说明

集合通信算子AllReduce的操作接口，将通信域内所有节点的输入数据进行相加（或其他归约操作）后，再把结果发送到所有节点的输出buffer，其中归约操作类型由op参数指定。

allreduce

函数原型

HcclResult HcclAllReduce(void *sendBuf, void *recvBuf, uint64_t count, HcclDataType dataType, HcclReduceOp op, HcclComm comm, aclrtStream stream)

参数说明

参数名	输入/输出	描述
sendBuf	输入	源数据buffer地址。
recvBuf	输出	目的数据buffer地址，集合通信结果输出至此buffer中。
count	输入	参与allreduce操作的数据个数，比如只有一个int32数据参与，则count=1。
dataType	输入	allreduce操作的数据类型，HcclDataType类型。不同的型号支持的数据类型不同，详细请参见dataType说明。
op	输入	reduce的操作类型。不同的型号支持的操作类型不同，详细请参见op说明。
comm	输入	集合通信操作所在的通信域。
stream	输入	本rank所使用的stream。

dataType说明

针对Ascend 950PR/Ascend 950DT，支持数据类型：int8、int16、int32、int64、uint64、float16、float32、float64、bfp16。针对int64、uint64、float64，当前仅支持节点内通信。
针对Atlas A3 训练系列产品/Atlas A3 推理系列产品，支持数据类型：int8、int16、int32、int64、float16、float32、bfp16。
针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，支持数据类型：int8、int16、int32、int64、float16、float32、bfp16。需要注意，针对int64数据类型，性能会有一定的劣化。
针对Atlas 训练系列产品，支持数据类型：int8、int32、int64、float16、float32。
针对Atlas 300I Duo 推理卡，支持数据类型：int8、int16、int32、float16、float32。

op说明

针对Ascend 950PR/Ascend 950DT，支持的操作类型为sum、prod、max、min，其中prod操作不支持int16、bfp16数据类型。
针对Atlas A3 训练系列产品/Atlas A3 推理系列产品，支持的操作类型为sum、prod、max、min，其中prod操作不支持int16、bfp16数据类型。
针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，支持的操作类型为sum、prod、max、min，其中prod操作不支持int16、bfp16数据类型。
针对Atlas 训练系列产品，支持的操作类型为sum、prod、max、min。
针对Atlas 300I Duo 推理卡，支持的操作类型为sum、prod、max、min，其中prod、max、min操作不支持int16数据类型。

返回值

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

约束说明

所有rank的count、dataType、op均应相同。
每个rank只能有一个输入。
算子的输入输出地址（sendBuf与recvBuf）根据不同的数据类型，应满足如下对齐要求：
- int8按照1 Byte地址对齐。
- int16、float16、bfp16按照2 Byte地址对齐。
- int32、float32按照4 Byte地址对齐。
- int64、uint64、float64按照8 Byte地址对齐。

调用示例

// 申请集合通信操作的Device 内存
void *sendBuf = nullptr;
void *recvBuf = nullptr;
uint64_t count = 8;
size_t mallocSize = count * sizeof(float);
aclrtMalloc((void **)&sendBuf, mallocSize, ACL_MEM_MALLOC_HUGE_ONLY);
aclrtMalloc((void **)&recvBuf, mallocSize, ACL_MEM_MALLOC_HUGE_ONLY);

// 初始化通信域
uint32_t rankSize = 8;
HcclComm hcclComm;
HcclCommInitRootInfo(rankSize, &rootInfo, deviceId, &hcclComm);

// 创建任务流
aclrtStream stream;
aclrtCreateStream(&stream);

// 执行AllReduce，将通信域内所有节点的输入数据进行相加后，再把结果发送到所有节点的输出buffer
HcclAllReduce(sendBuf, recvBuf, count, HCCL_DATA_TYPE_FP32, HCCL_REDUCE_SUM, hcclComm, stream);
// 阻塞等待任务流中的集合通信任务执行完成
aclrtSynchronizeStream(stream);

// 释放资源
aclrtFree(sendBuf);          // 释放Device侧内存
aclrtFree(recvBuf);          // 释放Device侧内存
aclrtDestroyStream(stream);  // 销毁任务流
HcclCommDestroy(hcclComm);   // 销毁通信域