aclnnWeightQuantMatmulAllReduce

产品支持情况

• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]。

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

功能说明

• 算子功能：对入参x2进行伪量化计算后，完成Matmul和allreduce计算。支持pertensor、perchannel、pergroupundefined。

• 计算公式：

  $$output = allreduce(x1 @ ((x2 + antiquantOffset) *antiquantScale) + bias+ x3)$$

函数原型

每个算子分为undefined，必须先调用“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)

aclnnWeightQuantMatmulAllReduceGetWorkspaceSize

• 参数说明：

  • x1(aclTensor *, 计算输入)：公式中的输入x1，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。Device侧的aclTensor，mm左矩阵。当前版本仅支持二维或者三维输入。
  • x2(aclTensor *, 计算输入)：公式中的输入x2，Device侧的aclTensor，mm右矩阵。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT8、INT4，undefined支持ND（当前版本仅支持二维输入）和FRACTAL_NZ格式（当前版本仅支持四维输入）。当x2的undefined为FRACTAL_NZ时，配合undefined和undefined完成输入ND到NZ的转换，undefined仅支持transpose场景。
  • bias(aclTensor *, 计算输入)：公式中的bias，Device侧的aclTensor，对应计算公式中bias偏移。数据格式支持ND。可选，参数，支持传入空指针，非空时当前版本仅支持一维输入。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型与x1保持一致。
  • antiquantScale(aclTensor *, 计算输入)：公式中的输入antiquantScale，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。pertensor场景shape为(1)；per_channel场景shape为(n)/(1,n)，n为x2最后一维的大小；pergroup场景shape为(ceil(k,antiquantGroupSize),n)。
  • antiquantOffset(aclTensor *, 计算输入)：公式中的输入antiquantOffset，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。对x2进行伪量化计算的offset参数，可选参数，支持传入空指针，非空时shape与antiquantScale一致。当x1是FLOAT16或者BFLOAT16，同时weight是FLOAT8_E5M2、FLOAT8_E4M3FN或者HIFLOAT8时，不支持该参数，填空指针。
  • x3(aclTensor *, 计算输入)：公式中的输入x3，undefined支持ND。mm计算后的偏移，可选参数，支持传入空指针，非空时shape与mm计算后的shape相同。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持BFLOAT16、FLOAT16。
  • group(char , 计算输入)：通信域名称，数据类型支持String。通过Hccl提供的接口“extern HcclResult HcclGetCommName(HcclComm comm, char commName);”获取，其中commName即为group。
  • reduceOp(char *, 计算输入)：reduce操作类型，数据类型支持String，目前仅支持"sum"。
  • commTurn(int64_t, 计算输入)：通信数据切分数，数据类型支持INT64，即总数据量/单次通信量，当前版本仅支持输入0。
  • streamMode(int64_t, 计算输入)：Host侧的整型，数据类型支持INT64。流模式的枚举，当前只支持枚举值1。
  • antiquantGroupSize(int64_t, 计算输入)：伪量化pergroup模式下，对x2进行反量化计算的groupSize输入；当不支持pergroup时，传入0，支持时，传入值的范围为[32,min(k-1,INT_MAX)]，且为32的倍数；k取值范围与undefined保持一致。
  • output(aclTensor *, 输出)：公式中的输出output。计算+通信的结果，shape和format与x1保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持BFLOAT16、FLOAT16。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnWeightQuantMatmulAllReduce

• 参数说明：

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

• 返回值：

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

约束说明

• 增量场景不使能MC2，全量场景使能MC2。
• 输入x1可为二维或者三维，其shape为(b, s, k)或者(m, k)。
• x2必须是二维。其shape为(k, n)，k轴满足mm算子入参要求，k轴相等，m的范围为[1, 2147483647]，k、n的范围为[1, 65535]。
• 传入的x1、x2、antiquantScale或者output不为空指针。
• 当输入x1的shape为(b, s, k)时，x3（非空场景）与输出output的shape为(b, s, n)；当输入x1的shape为(m, k)时，x3（非空场景）与输出output的shape为(m, n)。
• bias若非空，shape大小与output最后一维大小相等。antiquantScale在per-tensor场景下shape为(1)，在per-channel场景下shape为(1,n)/(n)，在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或者计算超时。
• 仅支持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。