aclnnMatmulAllReduceAddRmsNorm&aclnnInplaceMatmulAllReduceAddRmsNorm

支持的产品型号

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

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

接口原型

• aclnnMatmulAllReduceAddRmsNorm和aclnnInplaceMatmulAllReduceAddRmsNorm实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

  • aclnnMatmulAllReduceAddRmsNorm：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceMatmulAllReduceAddRmsNorm：无需新建输出张量对象，直接在输入张量residual的内存中存储计算结果。

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

• aclnnStatus aclnnMatmulAllReduceAddRmsNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *bias, const aclTensor *residual, const aclTensor *gamma, double epsilon, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, const aclTensor *y, const aclTensor *normOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnMatmulAllReduceAddRmsNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)
• aclnnStatus aclnnInplaceMatmulAllReduceAddRmsNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *bias, const aclTensor *residual, const aclTensor *gamma, double epsilon, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, const aclTensor *normOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnInplaceMatmulAllReduceAddRmsNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

功能描述

• 算子功能：完成mm + all_reduce + add + rms_norm计算。
• 计算公式：$$mm_out = allReduce(x1 @ x2 + bias)$$ $$y = mm_out + residual$$ $$normOut = \frac{y}{RMS(y)} * gamma, RMS(y) = \sqrt{\frac{1}{d} \sum_{i=1}^{d} y_{i}^{2} + epsilon}$$

aclnnMatmulAllReduceAddRmsNormGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：Device侧的两维或者三维aclTensor，mm左矩阵。数据类型支持FLOAT16、BFLOAT16。数据格式支持ND。不支持非连续tensor。当前版本仅支持两维或者三维输入。
  • x2（aclTensor*，计算输入）：Device侧的两维aclTensor，mm右矩阵。数据类型支持：FLOAT16、BFLOAT16。数据格式支持ND。支持最后两轴转置情况下的非连续tensor传入。当前版本仅支持两维输入。
  • bias（aclTensor*，计算输入）：Matmul计算之后的Add项，Device侧的aclTensor。数据类型支持FLOAT16、BFLOAT16。数据格式支持：ND。bias当前仅支持一维。
  • residual（aclTensor*，计算输入）：AddRmsNorm融合算子的残差输入，Device侧的三维aclTensor，数据类型支持FLOAT16、BFLOAT16。数据格式支持ND。不支持非连续tensor。inplace接口将该接口作为y的输出地址。
  • gamma（aclTensor*，计算输入）：AddRmsNorm融合算子的RmsNorm计算输入，Device侧的一维aclTensor，数据类型支持FLOAT16、BFLOAT16。数据格式支持ND。不支持非连续tensor。
  • epsilon（double，计算输入）：Host侧双精度，用于防止除0错误。默认值为1e-06
  • group（char*，计算输入）：通信域名称。数据类型支持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。
  • y（aclTensor*，计算输出）：Device侧的aclTensor，mm + all_reduce + add的结果。数据类型支持FLOAT16、BFLOAT16, 且数据类型同residual输入。
  • normOut（aclTensor*，计算输出）：Device侧的aclTensor，mm + all_reduce + add + rms_norm的结果。数据类型支持FLOAT16、BFLOAT16, 且数据类型同residual输入。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnMatmulAllReduceAddRmsNorm

• 参数说明：

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

• 返回值：

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

aclnnInplaceMatmulAllReduceAddRmsNormGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：Device侧的两维或者三维aclTensor，mm左矩阵。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。不支持非连续tensor。当前版本仅支持两维或者三维输入。
  • x2（aclTensor*，计算输入）：Device侧的两维aclTensor，mm右矩阵。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。支持最后两轴转置情况下的非连续tensor传入。当前版本仅支持两维输入。
  • bias（aclTensor*，计算输入）：Device侧的aclTensor。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。bias当前仅支持一维。
  • residual（aclTensor*，计算输入）：Device侧的三维aclTensor，数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。不支持非连续tensor。
  • gamma（aclTensor*，计算输入）：Device侧的一维aclTensor，数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND。不支持非连续tensor。
  • epsilon（double，计算输入）：Host侧双精度，用于防止除0错误。默认值为1e-06
  • 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侧的整型，acl流模式的枚举，当前只支持枚举值1，类型支持：int64_t。
  • normOut（aclTensor*，计算输出）：Device侧的aclTensor，mm + all_reduce + add + rms_norm的结果。数据类型支持FLOAT16、BFLOAT16, 且数据类型同residual输入。
  • workspaceSize（uint64_t*，出参）：Device侧的整型，返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：Device侧的aclOpExecutor，返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnInplaceMatmulAllReduceAddRmsNorm

• 参数说明：

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

• 返回值：

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

约束与限制

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

调用示例