aclnnMatmulReduceScatter

支持的产品型号

Atlas A2训练系列产品/Atlas 800I A2推理产品。

说明： 使用该接口时，请确保驱动固件包和CANN包都为配套的8.0.RC2版本或者配套的更高版本，否则将会引发报错，比如BUS ERROR等。

接口原型

每个算子分为两段式接口，必须先调用“aclnnMatmulReduceScatterGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnMatmulReduceScatter”接口执行计算。

aclnnStatus aclnnMatmulReduceScatterGetWorkspaceSize(const aclTensor* x1, const aclTensor* x2, const aclTensor* bias, const char* group, const char* reduceOp, int64_t commTurn, int64_t streamMode, const aclTensor* output, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnMatmulReduceScatter(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能：完成mm + reduce_scatter_base计算。
计算公式： $output=x1@x2$

aclnnMatmulReduceScatterGetWorkspaceSize

参数说明：
- x1（aclTensor*，计算输入）：Device侧的两维aclTensor，mm左矩阵。数据类型支持：FLOAT16、BFLOAT16，数据格式支持：ND。当前版本仅支持两维输入。
- x2（aclTensor*，计算输入）：Device侧的两维aclTensor，mm右矩阵。数据类型支持：FLOAT16、BFLOAT16，数据格式支持：ND。当前版本仅支持两维输入。
- bias（aclTensor*，计算输入）：Device侧的aclTensor。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。当前版本暂不支持bias输入为非0的场景。
- group（char*，计算输入）：Host侧的char，标识通信域的字符串。数据类型支持：String。
- reduceOp（char*，计算输入）：Host侧的char，reduce操作类型。数据类型支持：String。
- commTurn（int64_t，计算输入）：Host侧的整型，通信数据切分数，即总数据量/单次通信量。数据类型支持：int64_t。当前版本仅支持输入0。
- streamMode（int64_t，计算输入）：Host侧的整型，acl流模式的枚举，当前只支持枚举值1，数据类型支持：int64_t。
- output（aclTensor*，计算输出）：Device侧的aclTensor，计算+通信的结果。数据类型支持：FLOAT16、BFLOAT16，数据格式支持：ND。
- workspaceSize（uint64_t*，出参）：Device侧的整型，返回需要在Device侧申请的workspace大小。
- executor（aclOpExecutor**，出参）：Device侧的aclOpExecutor，返回op执行器，包含了算子计算流程。
返回值：

返回aclnnStatus状态码，具体参见undefined。

aclnnMatmulReduceScatter

参数说明：
- workspace（void*，入参）：在Device侧申请的workspace内存地址。
- workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnAllGatherMatmulGetWorkspaceSize获取。
- executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
- stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。
返回值：

返回aclnnStatus状态码，具体参见undefined。

约束与限制

输入x1为2维，其维度为(m, k)，Atlas A2训练系列产品/Atlas 800I A2推理产品 m须为卡数rank_size的整数倍。x2必须是2维，其维度为(k, n)，轴满足mm算子入参要求，k轴相等，且k轴取值范围为[256, 65535)。bias暂不支持输入为非0的场景。
输出为2维，其维度为(m/rank_size, n), rank_size为卡数。
x1、x2计算输入的数据类型要和output计算输出的数据类型一致。
只支持x2矩阵转置/不转置，x1矩阵支持不转置场景。
Atlas A2训练系列产品/Atlas 800I A2推理产品支持2、4、8卡，并且仅支持hccs链路all mesh组网。
一个模型中的AllGatherMatmul、MatmulReduceScatter或MatmulAllReduce算子，仅支持相同通信域。

调用示例

[object Object]