aclnnQuantMatmulAllReduceV3

支持的产品型号

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

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

接口原型

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

• aclnnStatus aclnnQuantMatmulAllReduceV3GetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *biasOptional, const aclTensor *x3Optional, const aclTensor *dequantScale, const aclTensor *pertokenScaleOptional, const aclTensor *commQuantScale1Optional, const aclTensor *commQuantScale2Optional, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, const aclTensor *output, uint64_t *workspaceSize, aclOpExecutor **executor);
• aclnnStatus aclnnQuantMatmulAllReduceV3(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream);

功能描述

• 算子功能：对量化后的入参x1、x2进行matmul、dequant和pertoken计算，接着与x3进行add操作，再对输出进行perchannel量化，然后进行all_to_all通信，对第一次通讯结果进行reduceSum计算，接着进行all_gather通信，最后对第二次通信结果进行dequant，得到最终输出。
• 计算公式：$$matmulAddOutPut = (dequantScale * pertokenScaleOptional * (x1_{int8}@x2_{int8} + biasOptional_{int32}) + x3Optional);$$ $$alltoallOutPut_{int8} = alltoall(matmulAddOutPut / commQuantScale1Optional);$$ $$reduceSumOutPut_{int8} = (add(alltoallOutPut_{int8}) * (commQuantScale1Optional / commQuantScale2Optional));$$ $$outPut = (allgather(reduceSumOutPut_{int8}) * commQuantScale2Optional);$$

aclnnQuantMatmulAllReduceV3GetWorkspaceSize

• 参数说明：

  • x1(const aclTensor *, 计算输入)：Device侧的aclTensor，mm左矩阵，维度可为2维或者3维。数据类型支持：INT8。数据格式支持：ND。不支持非连续输入。
  • x2(const aclTensor *, 计算输入)：Device侧的2维aclTensor，mm右矩阵，数据类型支持INT8，数据格式支持ND和FRACTAL_NZ格式，当x2的Format为FRACTAL_NZ时，维度仅支持4维，配合aclnnCalculateMatmulWeightSizeV2/aclnnTransMatmulWeightGetWorkspaceSize/aclnnTransMatmulWeight完成输入ND到NZ的转换，非连续的Tensor仅支持transpose场景。
  • biasOptional(const aclTensor *, 计算输入)：bias。维度为1维。数据类型支持：INT32。数据格式支持：ND，可选，可为空。非空时shape和x2最后一维相等
  • x3Optional(const aclTensor *, 计算输入)：x3，matmul计算后的add计算。维度与output一致。数据类型支持：FLOAT16、BFLOAT16。数据格式支持：ND，可选，可为空。
  • dequantScale(const aclTensor *, 计算输入)：dequantScale，必选，matmul计算后的去量化系数。数据类型支持：INT64,UINT64,FLOAT32,BFLOAT16。数据格式支持：ND。shape在per-tensor场景为[1]，per-channel场景为[n]/[1,n]。输出为BFLOAT16时，直接将BFLOAT16类型的dequantScale传入本接口;输出为FLOAT16时，如果pertokenScale不为空，可直接将FLOAT32类型的scale传入本接口，如果pertokenScale为空，则需提前调用TransQuantParamV2算子的aclnn接口来将scale转成INT64/UINT64数据类型。
  • pertokenScaleOptional(const aclTensor *, 计算输入)：pertokenScale，matmul计算后的pertoken去量化系数。可选，可为空，数据类型支持：FLOAT32，数据格式支持：ND。x1为[b, s, k]时shape为[b*s]，x1为[m, k]时shape为[m]。
  • commQuantScale1Optional(const aclTensor *, 计算输入)：commQuantScale1，matmulAdd计算后的perchannel量化系数。可选，可为空，数据类型支持：BFLOAT16,FLOAT16，数据格式支持：ND, x2为[k, n]时, shape可为[n]或者[1,n]。
  • commQuantScale2Optional(const aclTensor *, 计算输入)：commQuantScale2，allGather计算后的perchannel量化系数。可选，可为空，数据类型支持：BFLOAT16,FLOAT16，数据格式支持：ND, x2为[k, n]时, shape可为[n]或者[1,n]。
  • group(const char *, 计算输入)：通信域名称。数据类型支持：String。通过Hccl提供的接口获取：extern HcclResult HcclGetCommName(HcclComm comm, char* commName); commName即为group。
  • reduceOp(const char *, 计算输入)：reduce操作类型。数据类型支持：String。目前仅支持"sum"。
  • commTurn(int64_t, 计算输入)：通信数据切分数，即总数据量/单次通信量。数据类型支持：int64_t，当前版本仅支持输入为0。
  • streamMode(int64_t，计算输入)：Host侧的整型，acl流模式的枚举，当前只支持枚举值1。
  • output(aclTensor *, 输出)：计算+通信的结果。数据类型支持：FLOAT16、BFLOAT16。shape除最后一维与x1除最后一维相等，最后一维和x2最后一维相等。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnQuantMatmulAllReduceV3

• 参数说明：

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

• 返回值：

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

约束与限制

• 增量场景不使能MC2，全量场景使能MC2
• 输入x1可为2维或者3维，且不为空Tensor，其维度为(b, s, k)或者(m, k)。x2必须是2维，且不为空Tensor。其维度为(k, n)，k轴满足mm算子入参要求，k轴相等。
• m大小不超过2147483647，x1与x2的最后一维大小不超过65535，x1的最后一维指k，x2的最后一维指转置时的k或非转置时的n。
• 输出output除最后一维皆与输入x1除最后一维相等，输出output的最后1维与输入x2的最后1维相等。bias若非空，shape大小与output最后一维相等。x3若非空，shape大小与output相等。
• 传入的x1、x2、dequantScale或者output不为空指针。
• x1和x2、dequantScale、output、bias（非空场景）、x3（非空场景）的数据类型和数据格式需要在支持的范围之内。
• 若输出output类型为FLOAT16，dequantScale的类型为INT64、UINT64（输出类型为FLOAT16暂不支持x3）；若输出output类型为BFLOAT16，dequantScale的类型为BFLOAT16，x3的类型为BFLOAT16。
• 若传入的pertokenScale不为空指针，dequantScale、pertokenScale类型为FLOAT32。
• 若传入的commQuantScale1与commQuantScale2不为空指针，两个量化参数shape保持一致，类型需与算子输出类型保持一致，且每张卡输入保持一致。
• x1维度为[b, s, k]时pertokenScaleOptional维度为[b*s]，x1维度为[m, k]时pertokenScaleOptional维度为[m]
• reduceOp的数据在可选范围内。目前仅支持"sum"。
• streamMode的数据在可选范围内，目前仅支持1。
• 只支持x2矩阵转置/不转置，x1矩阵不支持转置场景。
• Atlas A2训练系列产品/Atlas 800I A2推理产品支持1、2、4、8卡，并且仅支持hccs链路all mesh组网。
• 不支持空tensor。
• 一个模型中的通算融合MC2算子，仅支持相同通信域。

调用示例