aclnnMatmulAllReduceV2

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	×
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	×

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

功能说明

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

函数原型

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

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

aclnnMatmulAllReduceV2GetWorkspaceSize

• 参数说明：

  • x1(aclTensor*, 计算输入)：公式中的输入x1，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。Device侧的aclTensor，mm左矩阵。当前版本仅支持二维或者三维输入。
  • x2(aclTensor*, 计算输入)：公式中的输入x2，数据类型支持BFLOAT16、FLOAT16，undefined支持ND；当前版本仅支持二维输入。
  • x3(aclTensor*, 计算输入)：公式中的输入x3，数据类型支持FLOAT16、BFLOAT16，undefined支持ND。Device侧的aclTensor，mm计算后的add计算，shape与mm计算后的shape一致。
  • bias(aclTensor*, 计算输入)：公式中的输入bias，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。Device侧的aclTensor，对应计算公式中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，通信数据切分数，即总数据量/单次通信量，当前版本仅支持输入0。
  • streamMode(int64_t, 计算输入)：Host侧的整型，类型支持INT64，流模式的枚举，当前版本仅支持枚举值1。
  • output(aclTensor*, 计算输出)：公式中的输出output，数据类型支持FLOAT16、BFLOAT16，且数据类型同x1输入。Device侧的aclTensor，mm计算+all_reduce_base通信的结果。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnMatmulAllReduceV2

• 参数说明：

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

• 返回值：

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

约束说明

• 增量场景不使能MC2，全量场景使能MC2。
• 输入x1可为二维或者三维，其shape为(b, s, k)或者(m, k)。x2必须是二维，其shape为(k, n)，轴满足mm算子入参要求，k轴相等。bias若非空，其shape为(n)。
• b*s、m、k、n的值均不得超过2147483647(INT32_MAX)。
• 当输入x1的shape为(b, s, k)时，输出output的shape为(b, s, n)；当输入x1的shape为(m, k)时，输出output的shape为(m, n)。
• x1、x2、bias计算输入的数据类型要和output计算输出的数据类型一致，传入的x1、x2、x3或者output不为空指针。
• 只支持x2矩阵转置/不转置，x1矩阵支持不转置场景。
• 仅支持hccs链路all mesh组网。
  • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：支持1、2、4、8卡。
• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：一个模型中的通算融合MC2算子，仅支持相同通信域。

调用示例

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