aclnnMatmulReduceScatter

支持的产品型号

• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品[object Object]。

说明： 使用该接口时，请确保驱动固件包和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=reducescatter(x1@x2+bias)$$

aclnnMatmulReduceScatterGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：Device侧的aclTensor，即计算公式中的x1。数据类型支持：FLOAT16、BFLOAT16，且与x2的数据类型保持一致。数据格式支持：ND。当前版本仅支持两维输入，且仅支持不转置场景。
  • x2（aclTensor*，计算输入）：Device侧的aclTensor，即计算公式中的x2。数据类型支持：FLOAT16、BFLOAT16，且与x1的数据类型保持一致。数据格式支持：ND。支持通过转置构造的undefined。当前版本仅支持两维输入。
  • bias（aclTensor*，计算输入）：Device侧的aclTensor，即计算公式中的bias。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。支持传入空指针的场景。当前版本仅支持一维输入，且暂不支持bias输入为非0的场景。
  • group（char*，计算输入）：Host侧的char，标识通信域的字符串，通信域名称。数据类型支持：String。通过Hccl提供的接口获取：extern HcclResult HcclGetCommName(HcclComm comm, char* commName)；commName即为group。
  • reduceOp（char*，计算输入）：Host侧的char，reduce操作类型。数据类型支持：String。当前版本仅支持“sum”。
  • commTurn（int64_t，计算输入）：Host侧的整型，通信数据切分数，即总数据量/单次通信量。数据类型支持：int64_t。当前版本仅支持输入0。
  • streamMode（int64_t，计算输入）：Host侧的整型，AscendCL流模式的枚举，当前只支持枚举值1，数据类型支持：int64_t。
  • output（aclTensor*，计算输出）：Device侧的aclTensor，mm计算+reducescatter通信的结果，即计算公式中的output。数据类型支持：FLOAT16、BFLOAT16，且与x1的数据类型保持一致。数据格式支持：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维，其shape为(m, k):
  • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品[object Object]：m须为卡数rank_size的整数倍。
• 输入x2必须是2维，其shape为(k, n)，轴满足mm算子入参要求，k轴相等，且k轴取值范围为[256, 65535)。
• x1/x2支持的空tensor场景，m和n可以为空，k不可为空：
  • m为空，k不为空，n不为空；
  • m不为空，k不为空，n为空；
  • m为空，k不为空，n为空。
• x2矩阵支持转置/不转置场景，x1矩阵只支持不转置场景。
• x1、x2计算输入的数据类型要和output计算输出的数据类型一致。
• bias暂不支持输入为非0的场景。
• 输出为2维，其shape为(m/rank_size, n), rank_size为卡数。
• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品[object Object]：支持2、4、8卡，并且仅支持hccs链路all mesh组网。
• 一个模型中的AllGatherMatmul、MatmulReduceScatter或MatmulAllReduce算子，仅支持相同通信域。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考undefined。