aclnnWeightQuantMatmulAllReduce

支持的产品型号

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

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

接口原型

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

• aclnnStatus aclnnWeightQuantMatmulAllReduceGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *bias, const aclTensor *antiquantScale, const aclTensor *antiquantOffset, const aclTensor *x3, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, int64_t antiquantGroupSize, const aclTensor *output, uint64_t *workspaceSize, aclOpExecutor **executor);
• aclnnStatus aclnnWeightQuantMatmulAllReduce(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream);

功能描述

• 算子功能：对入参x2进行伪量化计算后，完成mm + all_reduce_base计算。
• 计算公式：$$output = allreduce(x1 @ ((x2 + offset) * scale) + bias+ x3)$$

aclnnWeightQuantMatmulAllReduceGetWorkspaceSize

• 参数说明：

  • x1(const aclTensor *, 计算输入)：Device侧的aclTensor，mm左矩阵，维度可为2维或者3维，数据类型支持BFLOAT16、FLOAT16，数据格式支持ND。
  • x2(const aclTensor *, 计算输入)：Device侧的2维aclTensor，mm右矩阵，数据类型支持INT8、INT4，数据格式支持ND、FRACTAL_NZ。
  • bias(const aclTensor *, 计算输入)：Device侧的aclTensor，对应计算公式中bias偏移。维度为1维，数据类型支持BFLOAT16、FLOAT16，数据格式支持ND，可选，可为空，非空时shape和x2最后一维相等。
  • antiquantScale(const aclTensor *, 计算输入)：对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(const aclTensor *, 计算输入)：对x2进行伪量化计算的offset参数，数据类型支持BFLOAT16、FLOAT16，数据格式支持ND，可选，可为空，非空时shape与antiquantScale一致。
  • x3(const aclTensor *, 计算输入)：可选，matmul计算后的偏移，数据类型支持BFLOAT16、FLOAT16；数据格式支持ND，可选，可为空，非空时shape与matmul计算后的shape相同。
  • 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侧的整型，AscendCL流模式的枚举，当前只支持枚举值1，数据类型支持int64_t。
  • antiquantGroupSize(int64_t，计算输入)：伪量化per_group模式下，对x2进行反量化计算的groupSize输入；当不支持per_group时，传入0，支持时，传入值的范围为[32,min(k-1,INT_MAX)]，且为32的倍数；k取值范围与matmul接口保持一致。
  • output(aclTensor *, 输出)：计算+通信的结果，数据类型支持BFLOAT16、FLOAT16；数据类型与x1保持一致；shape除最后一维与x1除最后一维相等，最后一维和x2最后一维相等。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnWeightQuantMatmulAllReduce

• 参数说明：

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

• 返回值：

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

约束与限制

• 增量场景不使能MC2，全量场景使能MC2。
• 输入x1可为2维或者3维，其维度为(b, s, k)或者(m, k)。x2必须是2维。其维度为(k, n)，k轴满足matmul算子入参要求，k轴相等，k、n的范围为[1, 65535]。
• 传入的x1、x2、antiquantScale或者output不为空指针。
• x3（非空场景）以及输出output除最后一维皆与输入x1除最后一维相等，x3（非空场景）以及输出output的最后1维与输入x2的最后1维相等。bias若非空，shape大小与output最后一维相等。antiquantScale满足per-tensor场景shape为[1]，per-channel场景shape为[1,n]/[n]，n如果为1时，per-tensor和per-channel都只有1个数值,此时统一当做是per-tensor场景，per-group场景shape为[ceil(k,antiquantGroupSize),n]。antiquantOffset若非空，shape与antiquantScale一致。
• x1和x2，x3（非空场景）、antiquantScale、antiquantOffset（非空场景）、output、bias（非空场景）的数据类型和数据格式需要在支持的范围之内。
• x1，antiquantScale，antiquantOffset（非空场景），x3（非空场景）、bias（非空场景）output的数据类型相同 。
• antiquantGroupSize取值满足取值范围且为32倍数。
• 只支持x2矩阵转置/不转置，x1矩阵不支持转置场景。
• 在长序列场景，随着b/s或者m的增大，可能出现OOM或者计算超时。
• x2的Format为FRACTAL_NZ时，维度仅支持2维，配合aclnnCalculateMatmulWeightSizeV2/aclnnTransMatmulWeightGetWorkspaceSize/aclnnTransMatmulWeight完成输入ND到NZ的转换。
• Atlas A2训练系列产品/Atlas 800I A2推理产品支持1、2、4、8卡，并且仅支持hccs链路all mesh组网。

调用示例

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