aclnnMatmulAllReduce

支持的产品型号

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

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

接口原型

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

• aclnnStatus aclnnMatmulAllReduceGetWorkspaceSize(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 aclnnMatmulAllReduce(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

功能描述

• 算子功能：完成mm + all_reduce_base计算。
• 计算公式：$$output = allreduce(x1 @ x2 + bias)$$

aclnnMatmulAllReduceGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：Device侧的两维或者三维aclTensor，mm左矩阵，数据类型支持BFLOAT16、FLOAT16，数据格式支持ND，当前版本仅支持两维或者三维输入。
  • x2（aclTensor*，计算输入）：Device侧的两维aclTensor，mm右矩阵，数据类型支持BFLOAT16、FLOAT16，数据格式支持ND。当前版本仅支持两维输入。
  • bias（aclTensor*，计算输入）：Device侧的aclTensor，对应计算公式中bias偏移。数据类型支持BFLOAT16、FLOAT16，数据格式支持ND，bias当前仅支持一维。
  • group（char*，计算输入）：Host侧标识列组的字符串，通信域名称，数据类型支持string，通过Hccl提供的接口获取：extern HcclResult HcclGetCommName(HcclComm comm, char* commName); commName即为group。
  • reduceOp（char*，计算输入）：reduce操作类型，数据类型支持String，当前版本仅支持输入"sum"。
  • commTurn（int64_t，计算输入）：Host侧的整型，通信数据切分数，即总数据量/单次通信量，数据类型支持int64_t。当前版本仅支持输入0。
  • streamMode（int64_t，计算输入）：Host侧的整型，AscendCL流模式的枚举，当前只支持枚举值1，类型支持int64_t。
  • output（aclTensor*，计算输出）：Device侧的aclTensor，mm计算+all_reduce_base通信的结果，数据类型支持FLOAT16、BFLOAT16, 且数据类型同x1输入。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor **，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnMatmulAllReduce

• 参数说明：

  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t,入参）：在Device侧申请的workspace大小，由第一段接口aclnnMatmulAllReduceGetWorkspaceSize。
  • executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
  • stream（const aclrtStream，入参）：指定执行任务的AscendCL stream流。

• 返回值：

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

约束与限制

• 增量场景不使能MC2，全量场景使能MC2
• 输入x1可为2维或者3维，其维度为(b, s, k)或者(m, k)。x2必须是2维，其维度为(k, n)，轴满足mm算子入参要求，k轴相等。bias若非空，bias为1维。
• 在Atlas A2训练系列产品/Atlas 800I A2推理产品上，b*s、m、k、n的值均不得超过2147483647(INT32_MAX)。
• 输出output除最后一维皆与输入x1除最后一维相等，输出output的最后1维与输入x2的最后1维相等。bias若非空，shape大小与output最后一维相等。
• x1、x2、bias（若支持）计算输入的数据类型要和output计算输出的数据类型一致。
• 只支持x2矩阵转置/不转置，x1矩阵支持不转置场景。
• Atlas A2训练系列产品/Atlas 800I A2推理产品支持1、2、4、8卡，并且仅支持hccs链路all mesh组网。
• 一个模型中的通算融合MC2算子，仅支持相同通信域。

调用示例

• Atlas A2训练系列产品/Atlas 800I A2推理产品 ND格式调用示例；