aclnnWeightQuantMatmulAllReduceAddRmsNorm&aclnnInplaceWeightQuantMatmulAllReduceAddRmsNorm

支持的产品型号

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

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

接口原型

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

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

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

• aclnnStatus aclnnWeightQuantMatmulAllReduceAddRmsNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *bias, const aclTensor *antiquantScale, const aclTensor *antiquantOffset, const aclTensor *residual, const aclTensor *gamma, double epsilon, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, int64_t antiquantGroupSize, const aclTensor *y, const aclTensor *normOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnWeightQuantMatmulAllReduceAddRmsNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)
• aclnnStatus aclnnInplaceWeightQuantMatmulAllReduceAddRmsNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *bias, const aclTensor *antiquantScale, const aclTensor *antiquantOffset, const aclTensor *residual, const aclTensor *gamma, double epsilon, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, int64_t antiquantGroupSize, const aclTensor *normOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnInplaceWeightQuantMatmulAllReduceAddRmsNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

功能描述

• 算子功能：完成mm + all_reduce + add + rms_norm计算。
• 计算公式：$$mm\_out = allReduce(x1 @ (x2*antiquantScale + antiquantOffset) + 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}$$

aclnnWeightQuantMatmulAllReduceAddRmsNormGetWorkspaceSize

• 参数说明：

  • x1(const aclTensor *, 计算输入)：Device侧的aclTensor，mm左矩阵，维度可为2维或者3维。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND。
  • x2(const aclTensor *, 计算输入)：Device侧的2维aclTensor，mm右矩阵。数据类型支持：INT8、INT4。数据格式支持：ND。
  • bias(const aclTensor *, 计算输入)：bias。维度为1维。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND，可选，可为空。非空时shape和x2最后一维相等
  • antiquantScale(aclTensor*, 计算输入)：antiquantScale，对x2进行伪量化计算的scale参数。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND。per_tensor场景shape为[1]，per_channel场景shape为[n] / [1,n]，n为x2最后一维的大小。per_group场景shape为（ceil(k,antiquantGroupSize),n）。
  • antiquantOffset(aclTensor*, 计算输入)：antiquantOffset，对x2进行伪量化计算的offset参数。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND，可选，可为空。非空时shape，与antiquantScale一致。
  • 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侧的整型，acl流模式的枚举，当前只支持枚举值1，类型支持：int64_t。
  • antiquantGroupSize(int64_t，计算输入):伪量化per_group模式下，对x2进行反量化计算的groupSize输入。当不支持per_group时，传入0，支持时，传入值的范围为[32,min(k-1,INT_MAX)],且为32的倍数。k取值范围与matmul接口保持一致
  • 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。

aclnnWeightQuantMatmulAllReduceAddRmsNorm

• 参数说明：

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

• 返回值：

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

aclnnInplaceWeightQuantMatmulAllReduceAddRmsNormGetWorkspaceSize

• 参数说明：

  • x1(const aclTensor *, 计算输入)：Device侧的aclTensor，mm左矩阵，维度可为2维或者3维。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND。
  • x2(const aclTensor *, 计算输入)：Device侧的2维aclTensor，mm右矩阵。数据类型支持：INT8、INT4。数据格式支持：ND。
  • bias(const aclTensor *, 计算输入)：bias。维度为1维。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND，可选，可为空。非空时shape和x2最后一维相等
  • antiquantScale(aclTensor*, 计算输入)：antiquantScale，对x2进行伪量化计算的scale参数。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND。per_tensor场景shape为[1]，per_channel场景shape为[n] / [1,n]，n为x2最后一维的大小。per_group场景shape为（ceil(k,antiquantGroupSize),n）。
  • antiquantOffset(aclTensor*, 计算输入)：antiquantOffset，对x2进行伪量化计算的offset参数。数据类型支持：BFLOAT16，FLOAT16。数据格式支持：ND，可选，可为空。非空时shape，与antiquantScale一致。
  • 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。
  • antiquantGroupSize(int64_t，计算输入):伪量化per_group模式下，对x2进行反量化计算的groupSize输入。当不支持per_group时，传入0，支持时，传入值的范围为[32,min(k-1,INT_MAX)],且为32的倍数。k取值范围与matmul接口保持一致
  • normOut（aclTensor*，计算输出）：Device侧的aclTensor，mm + all_reduce + add + rms_norm的结果。数据类型支持FLOAT16、BFLOAT16, 且数据类型同residual输入。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor **，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnInplaceWeightQuantMatmulAllReduceAddRmsNorm

• 参数说明：

  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t,入参）：在Device侧申请的workspace大小，由第一段接口aclnnInplaceWeightQuantMatmulAllReduceAddRmsNormGetWorkspaceSize。
  • 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轴相等，k、n的范围为[1, 65535]。bias若非空，bias为1维，其维度为（n）。
• 输入residual必须是3维，其维度为(b, s, n)，当x1为两维时，residual的(b*s)等于x1的s。输入gamma必须是一维，其维度为（n）。
• antiquantScale满足per-tensor场景shape为[1]，per-channel场景shape为[1,n][n]，per-group场景shape为[ceil(k,antiquantGroupSize),n]。antiquantOffset若非空，shape与antiquantScale一致。
• 输出y和normOut的维度和数据类型同residual。bias若非空，shape大小与最后一维相等。
• x2的数据类型需为int8或者int4，x1、bias（若支持）、residual、gamma、y、normOut计算输入的数据类型要一致。
• 只支持x2矩阵转置/不转置，x1矩阵支持不转置场景。
• antiquantGroupSize取值满足取值范围[32, min(k-1, INT_MAX)]且为32倍数。
• 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。

调用示例