aclnnQuantMatmulAllReduceV4

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品 [object Object]	×
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件 [object Object]	×
[object Object]Atlas 200I/500 A2 推理产品 [object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品 [object Object]	×

功能说明

• 算子功能：兼容aclnnQuantMatmulAllReduce、aclnnQuantMatmulAllReduceV2、aclnnQuantMatmulAllReduceV3支持的功能，在此基础上新增perblockundefined的支持。新增x1，x2输入支持dtype为FLOAT8_E4M3FN、FLOAT8_E5M2、HIFLOAT8、FLOAT4_E2M1、FLOAT4_E1M2。

• 计算公式：

  • commQuantScale1Optional, commQuantScale2Optional不为空时:$$matmulAddOutput = (x2Scale * x1ScaleOptional * (x1_{int8}@x2_{int8} + biasOptional_{int32}) + x3Optional);$$ $$alltoallOutput_{int8} = alltoall(matmulAddOutput / commQuantScale1Optional);$$ $$reduceSumOutput_{int8} = (add(alltoallOutput_{int8}) * (commQuantScale1Optional / commQuantScale2Optional));$$ $$output = (allgather(reduceSumOutput_{int8}) * commQuantScale2Optional);$$
  • x1，x2为INT8，无x1ScaleOptional，x2Scale为INT64/UINT64，可选biasOptional为INT32，out为BFLOAT16/FLOAT16：$$output = allReduce((x1@x2 + biasOptional) * x2Scale + x3Optional)$$
  • x1，x2为INT8，x1ScaleOptional为FLOAT32，x2Scale为FLOAT32/BFLOAT16，可选biasOptional为INT32, out为FOAT16/BFLOAT16：$$output = allReduce((x1@x2 + biasOptional) * x2Scale * x1ScaleOptional + x3Optional)$$
  • x1，x2为FLOAT4_E2M1/FLOAT4_E1M2/FLOAT8_E4M3FN/FLOAT8_E5M2，x1ScaleOptional为FLOAT8_E8M0，x2Scale为FLOAT8_E8M0，可选biasOptional为FLOAT32, out为FOAT16/BFLOAT16/FLOAT32：$$output = allReduce((x1* x1ScaleOptional)@(x2* x2Scale) + biasOptional + x3Optional)$$
  • x1，x2为FLOAT8_E4M3FN/FLOAT8_E5M2/HIFLOAT8，x1ScaleOptional为FLOAT32，x2Scale为FLOAT32，可选bias为FLOAT32, out为FOAT16/BFLOAT16/FLOAT32：$$output = allReduce((x1@x2 + biasOptional) * x2Scale * x1ScaleOptional + x3Optional)$$
  • x1，x2为FLOAT8_E4M3FN/FLOAT8_E5M2/HIFLOAT8，x1ScaleOptional为FLOAT32，x2Scale为FLOAT32，无biasOptional。当x1为(a0, a1)，x2为(b0, b1)时x1ScaleOptional为(ceildiv(a0，128), ceildiv(a1，128))x2Scale为(ceildiv(b0，128), ceildiv(b1，128)), out为FOAT16/BFLOAT16/FLOAT32:$$output_{pq} = allReduce(\sum_{0}^{\left \lfloor \frac{k}{128} \right \rfloor} (x1_{pr}@x2_{rq}*(x1ScaleOptional_{pr}*x2Scale_{rq})) + x3)$$

函数原型

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

• aclnnStatus aclnnQuantMatmulAllReduceV4GetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *biasOptional, const aclTensor *x3Optional, const aclTensor *x1ScaleOptional, const aclTensor *x2Scale, const aclTensor *commQuantScale1Optional, const aclTensor *commQuantScale2Optional, const char* group, const char *reduceOp, int64_t commTurn, int64_t streamMode, int64_t groupSize, int64_t commQuantMode,const aclTensor *output, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnQuantMatmulAllReduceV4(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnQuantMatmulAllReduceV4GetWorkspaceSize

• 参数说明：

  • x1(aclTensor*, 计算输入)：公式中的输入x1，Device侧的aclTensor，mm左矩阵。undefined支持ND，数据类型支持INT8、FLOAT8_E4M3FN、FLOAT8_E5M2、HIFLOAT8、FLOAT4_E2M1、FLOAT4_E1M2。当前版本仅支持二维或者三维输入，不支持非连续输入。
  • x2(aclTensor*, 计算输入)：公式中的输入x2，Device侧的aclTensor，mm右矩阵。undefined仅支持ND格式，数据类型支持INT8、FLOAT8_E4M3FN、FLOAT8_E5M2、HIFLOAT8、FLOAT4_E2M1、FLOAT4_E1M2。当前版本仅支持二维输入。
  • biasOptional(aclTensor*, 计算输入)：公式中的输入biasOptional，Device侧的aclTensor，可选参数。undefined支持ND，数据类型支持INT32、FLOAT32。当前版本仅支持一维输入。
  • x3Optional(aclTensor*, 计算输入)：公式中的输入x3Optional，Device侧的aclTensor，可选参数。undefined支持ND，数据类型支持FLOAT16、BFLOAT16、FLOAT32。低比特通信场景下仅支持输出为BFLOAT16场景，且仅支持非空输入，要求维度与output的维度一致
  • x1ScaleOptional(aclTensor*, 计算输入)：公式中的输入x1ScaleOptional，Device侧的aclTensor，mm计算后的pertoken去量化系数, 可选参数。undefined支持ND，数据类型支持FLOAT32、FLOAT8_E8M0。x1为(b, s, k)时shape为(b*s)，x1为(m, k)时shape为(m)。perblock场景下，x1为(b, s, k)时shape为[b, ceilDiv(s, 128), ceilDiv(k, 128)]，x1为(m, k)时shape为[ceilDiv(m, 128), ceilDiv(k, 128)]。数据类型为FLOAT8_E8M0时，shape为[b, s, ceilDiv(k, 32)]或者[m, ceilDiv(k, 32)]，且必须保证ceilDiv(k, 32)为偶数。
  • x2Scale(aclTensor*, 计算输入)：公式中的输入x2Scale，Device侧的aclTensor，mm计算后的去量化系数。undefined支持ND，数据类型支持INT64、UINT64、FLOAT32、BFLOAT16, FLOAT32、FLOAT8_E8M0。shape在pertensor场景为(1)，perchannel场景为(n)/(1, n)。
    • 输出为BFLOAT16时，直接将BFLOAT16类型的dequantScale传入本接口；
    • 输出为FLOAT16且输入为INT8时，x1ScaleOptional不为空，可直接将FLOAT32类型的x2Scale传入本接口，如果x1ScaleOptional为空，则需提前调用TransQuantParamV2算子的aclnn接口来将x2Scale转成INT64/UINT64数据类型。数据类型为FLOAT8_E8M0时，仅支持转置，shape为[n, k]时，x2Scale的shape为[n, ceilDiv(k, 32)]，且必须保证ceilDiv(k, 32)为偶数。perblock场景下，x2的shape为[ceilDiv(k, 128), ceilDiv(n, 128)]，x2转置时，x2Scale的shape为[ceilDiv(n, 128), ceilDiv(k, 128)]。
  • commQuantScale1Optional(aclTensor*, 计算输入)：公式中的输入commQuantScale1，Device侧的aclTensor，matmulAdd计算后的perchannel量化系数，可选参数。undefined支持ND，数据类型支持BFLOAT16、FLOAT16。x2为(k, n)时, shape可为(n)或者(1,n)
  • commQuantScale2Optional(aclTensor*, 计算输入)：公式中的输入commQuantScale2，Device侧的aclTensor，allGather计算后的perchannel量化系数，可选参数。undefined支持ND数据类型支持BFLOAT16、FLOAT16。x2为(k, n)时, shape可为(n)或者(1,n)。
  • 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。
  • groupSize(int64_t，计算输入)：用于表示反量化中x1Scale/x2Scale输入的一个数在其所在的对应维度方向上可以用于该方向x1/x2输入的多少个数的反量化。groupSize输入由3个方向的groupSizeM，groupSizeN，groupSizeK三个值拼接组成，每个值占16位，计算公式为：groupSize = groupSizeK | groupSizeN << 16 | groupSizeM << 32。当前groupSizeM，groupSizeN，groupSizeK仅支持128。
  • commQuantMode(int64_t，计算输入)：静态量化和动态量化的标志位，数值为0和1。
  • output(aclTensor *, 输出)：公式中的output, Device侧的aclTensor，计算+通信的结果。数据类型支持ND，数据类型支持FLOAT16、BFLOAT16、FLOAT32。维度为(b, s, n)或者(m, n)。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnQuantMatmulAllReduceV4

• 参数说明：

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

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

约束说明

• 增量场景不使能MC2，全量场景使能MC2。
• 输入x1可为2维或者3维，且不为空Tensor，其shape为(b, s, k)或者(m, k)。x2必须是2维，且不为空Tensor。其shape为(k, n)，k轴满足mm算子入参要求，k轴相等。
• m大小不超过2147483647，x1与x2的最后一维大小不超过65535，x1的最后一维指k，x2的最后一维指转置时的k或非转置时的n。
• 传入的x1、x2、x2Scale或者output不为空指针。
• x1和x2、dequantScale、output、bias（非空场景）、x3（非空场景）的数据类型和数据格式需要在支持的范围之内。
• 若输出output类型为FLOAT16，当x1ScaleOptional为空时，x2Scale的类型为INT64、UINT64，当x1ScaleOptional不为空时，x2Scale的类型为FLOAT32；若输出output类型为BFLOAT16，x2Scale的类型为BFLOAT16，x3的类型为BFLOAT16。
• 传入的commQuantScale1与commQuantScale2需要同时为空指针或同时不为空指针，若传入的commQuantScale1与commQuantScale2同时不为空指针，两个量化参数shape需保持一致，类型需与算子输出类型保持一致，且每张卡输入保持一致。
• streamMode的数据在可选范围内，目前仅支持1。
• 只支持x2矩阵转置/不转置，x1矩阵不支持转置场景。
• 支持1、2、4、8、16、32、64卡，并且仅支持hccs链路all mesh组网。
• 不支持空tensor。
• 一个模型中的通算融合MC2算子，仅支持相同通信域。
• int8低bit通信仅在通信bound的情况下存在性能收益，计算bound的情况不建议使能int8低bit通信，即不建议输入commQuantScale1和 commQuantScale2。

调用示例

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