aclnnQuantMatmulAllReduceV3

产品支持情况

产品	是否支持
[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]	×

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

功能说明

• 算子功能：对量化后的入参x1、x2进行matmul、dequant和pertoken计算，接着与x3进行add操作，再对输出进行perchannel量化，然后进行all_to_all通信，对第一次通讯结果进行reduceSum计算，接着进行all_gather通信，最后对第二次通信结果进行dequant，得到最终输出。支持pertensor、perchannel、pertokenundefined。
• 计算公式：$$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);$$

函数原型

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

aclnnQuantMatmulAllReduceV3GetWorkspaceSize

• 参数说明：

  • x1(aclTensor*, 计算输入)：公式中的输入x1，数据类型支持INT8，undefined支持ND。Device侧的aclTensor，mm左矩阵，不支持非连续输入。当前版本仅支持二维或者三维输入。
  • x2(aclTensor*, 计算输入)：公式中的输入x2，数据类型支持INT8，Device侧的aclTensor，mm右矩阵。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：undefined支持ND和FRACTAL_NZ格式。 输入的shape规则如下：
      • 当x2的undefined为FRACTAL_NZ时，当前版本仅支持四维输入，配合undefined和undefined完成输入ND到NZ的转换，undefined仅支持transpose场景。
      • 当x2的undefined为ND时，当前版本仅支持二维输入。
  • biasOptional(aclTensor*, 计算输入)：公式中的输入biasOptional，数据类型支持INT32，undefined支持ND。Device侧的aclTensor，对应计算公式中bias偏移。可选，可为空。当前版本仅支持一维输入。
  • x3Optional(aclTensor*, 计算输入)：公式中的输入x3Optional，数据类型支持FLOAT16、BFLOAT16，undefined支持ND。Device侧的aclTensor，mm计算后的add计算，维度与output一致。目前仅支持输出为BFLOAT16场景，且仅支持非空输入。
  • dequantScale(aclTensor*, 计算输入)：公式中的输入dequantScale，数据类型支持INT64、UINT64、FLOAT32、BFLOAT16，undefined支持ND。mm计算后的去量化系数。shape在per-tensor场景为(1)，per-channel场景为(n)/(1, n)。
    • 输出为BFLOAT16时，直接将BFLOAT16类型的dequantScale传入本接口；
    • 输出为FLOAT16时，如果pertokenScale不为空，可直接将FLOAT32类型的dequantScale传入本接口，如果pertokenScale为空，则需提前调用TransQuantParamV2算子的aclnn接口来将dequantScale转成INT64/UINT64数据类型。
  • pertokenScaleOptional(aclTensor*, 计算输入)：公式中的输入pertokenScaleOptional，mm计算后的pertoken去量化系数，数据类型支持FLOAT32，undefined支持ND。可选，可为空。x1为(b, s, k)时shape为(b*s)，x1为(m, k)时shape为(m)。
  • commQuantScale1Optional(aclTensor*, 计算输入)：公式中的输入commQuantScale1，matmulAdd计算后的perchannel量化系数，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。Device侧的aclTensor，可选，可为空，x2为(k, n)时, shape可为(n)或者(1,n)。
  • commQuantScale2Optional(aclTensor*, 计算输入)：公式中的输入commQuantScale2，allGather计算后的perchannel量化系数，数据类型支持BFLOAT16、FLOAT16，undefined支持ND。Device侧的aclTensor，可选，可为空，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。
  • output(aclTensor *, 输出)：计算+通信的结果，数据类型支持FLOAT16、BFLOAT16，维度为(b, s, n)或者(m, n)。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnQuantMatmulAllReduceV3

• 参数说明：

  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t, 入参）：在Device侧申请的workspace大小，由第一段接口aclnnQuantMatmulAllReduceV3GetWorkspaceSize获取。
  • 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、dequantScale或者output不为空指针。
• x1和x2、dequantScale、output、bias（非空场景）、x3（非空场景）的数据类型和数据格式需要在支持的范围之内。
• 若输出output类型为FLOAT16，当pertokenScale为空时，dequantScale的类型为INT64、UINT64，当pertokenScale不为空时，dequantScale的类型为FLOAT32；若输出output类型为BFLOAT16，dequantScale的类型为BFLOAT16，x3的类型为BFLOAT16。
• 传入的commQuantScale1与commQuantScale2需要同时为空指针或同时不为空指针，若传入的commQuantScale1与commQuantScale2同时不为空指针，两个量化参数shape需保持一致，类型需与算子输出类型保持一致，且每张卡输入保持一致。
• x1的shape为(b, s, k)时，pertokenScaleOptional的shape为(b*s)；当x1的shape为(m, k)时，pertokenScaleOptional的shape为(m)。
• streamMode的数据在可选范围内，目前仅支持1。
• 只支持x2矩阵转置/不转置，x1矩阵不支持转置场景。
• 仅支持hccs链路all mesh组网。
  • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：支持1、2、4、8卡。
• 不支持空tensor。
• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：一个模型中的通算融合MC2算子，仅支持相同通信域。
• int8低bit通信仅在通信bound的情况下存在性能收益，计算bound的情况不建议使能int8低bit通信，即不建议输入commQuantScale1和commQuantScale2。

调用示例

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