aclnnWeightQuantBatchMatmulV2

支持的产品型号

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

接口原型

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

• aclnnStatus aclnnWeightQuantBatchMatmulV2GetWorkspaceSize(const aclTensor *x, const aclTensor *weight, const aclTensor *antiquantScale, const aclTensor *antiquantOffsetOptional, const aclTensor *quantScaleOptional, const aclTensor *quantOffsetOptional, const aclTensor *biasOptional, int antiquantGroupSize, const aclTensor *y, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnWeightQuantBatchMatmulV2(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：完成一个输入为伪量化场景的矩阵乘计算，并可以实现对于输出的量化计算。
• 计算公式：$$y = x @ ANTIQUANT(weight) + bias$$ 公式中的$weight$为伪量化场景的输入，其反量化公式$ANTIQUANT(weight)$为$$ANTIQUANT(weight) = (weight + antiquantOffset) * antiquantScale$$ 当客户配置quantScaleOptional输入时, 会对输出进行量化处理, 其量化公式为$$\begin{aligned} y &= QUANT(x @ ANTIQUANT(weight) + bias) \\ &= (x @ ANTIQUANT(weight) + bias) * quantScale + quantOffset \\ \end{aligned}$$ 当客户配置quantScaleOptional输入为nullptr, 则直接输出:$$y = x @ ANTIQUANT(weight) + bias$$

aclnnWeightQuantBatchMatmulV2GetWorkspaceSize

• 参数说明

  • x(const aclTensor*, 计算输入)：公式中的输入x，数据类型支持FLOAT16、BFLOAT16，undefined支持ND。undefined仅支持transpose场景。维度支持二维，shape支持(m, k)，其中Reduce维度k需要与weight的Reduce维度k大小相等；Atlas 推理系列产品中数据类型仅支持FLOAT16，当weight输入Format为FRACTAL_NZ时维度仅支持2维。其余限制与其他平台一致。

  • weight(const aclTensor*, 计算输入)：公式中的输入weight，数据类型支持INT8、INT4、INT32(仅在INT4Pack场景支持，需要配合aclnnConvertWeightToINT4Pack接口完成从INT32到INT4Pack的转换, undefined),其中若数据类型为INT4，则weight的内轴应为偶数。Atlas A2训练系列产品/Atlas 800I A2推理产品中undefined支持ND、FRACTAL_NZ, undefined仅支持transpose场景。维度支持二维，shape支持(k, n)，其中Reduce维度k需要与x的Reduce维度k大小相等；Atlas 推理系列产品中数据类型仅支持INT8, undefined支持FRACTAL_NZ，维度仅支持2维，且输入shape需要为（n, k），配合aclnnCalculateMatmulWeightSizeV2以及aclnnTransMatmulWeight完成输入Format从ND到FRACTAL_NZ的转换，undefined。其余限制与其他平台一致。

  • antiquantScale(const aclTensor*, 计算输入)：实现输入反量化计算的反量化scale参数，反量化公式中的输入antiquantScale，数据类型支持FLOAT16、BFLOAT16，且要求和输入x的数据类型保持一致。Atlas A2训练系列产品/Atlas 800I A2推理产品中，数据类型还支持UINT64（使用该类型时x仅支持FLOAT16，weight仅支持转置，模式仅支持per_channel, quantScaleOptional和quantOffsetOptional必须为空），需要首先配合aclnnCast接口完成FLOAT16到FLOAT32的转换，undefined，再配合aclnnTransQuantParamV2接口完成FLOAT32到UINT64的转换，undefined。undefined支持ND。undefined仅支持transpose场景。对于不同伪量化算法模式，antiquantScale支持的shape如下:

    • per_tensor模式：(1,)
    • per_channel模式：Atlas A2训练系列产品/Atlas 800I A2推理产品中输入shape为(1, n)或(n,)。Atlas 推理系列产品中输入shape需要为(n, 1)或(n,)。
    • per_group模式：Atlas A2训练系列产品/Atlas 800I A2推理产品中输入shape为(ceil(k, group_size), n)。Atlas 推理系列产品中输入shape需要为(n, ceil(k, group_size))。

  • antiquantOffsetOptional(const aclTensor*, 计算输入)：实现输入反量化计算的反量化offset参数，反量化公式中的输入antiquantOffset，数据类型支持FLOAT16、BFLOAT16，且要求和输入x的数据类型保持一致。Atlas A2训练系列产品/Atlas 800I A2推理产品中，数据类型还支持INT32，且数据范围限制为[-128, 127]（使用该类型时，antiquantScale仅支持UINT64）。可选输入, 当不需要时为空指针；存在时shape要求与antiquantScale一致。undefined支持ND。undefined仅支持transpose场景。

  • quantScaleOptional(const aclTensor*, 计算输入)：实现输出量化计算的量化参数（Atlas 推理系列产品中为预留参数，暂未使用），由量化公式中的quantScale和quantOffset的数据通过aclnnTransQuantParam接口转化得到。数据类型支持UINT64，undefined支持ND。不支持undefined。可选输入，当不需要时为空指针（Atlas 推理系列产品中为预留参数，暂未使用）；对于不同的伪量化算法模式，支持的shape如下:

    • per_tensor模式：(1,)
    • per_channel模式：(1, n)或(n,)

  • quantOffsetOptional(const aclTensor*, 计算输入)：实现输出量化计算的量化offset参数，量化公式中的输入quantOffset，数据类型支持FLOAT，undefined支持ND。可选输入, 当不需要时为空指针（Atlas 推理系列产品中为预留参数，暂未使用）；存在时shape要求与quantScaleOptional一致。不支持undefined。

  • biasOptional(aclTensor*, 计算输入)：偏置输入，公式中的输入bias。当输入x的数据类型为BFLOAT16时，数据类型要求为FLOAT；当输入x的数据类型为FLOAT16时，数据类型要求为FLOAT16。可选输入, 当不需要时为空指针；存在输入时支持1维或2维，shape支持(n,)或(1, n)。支持ND。不支持undefined。

  • antiquantGroupSize(int, 计算输入)：表示伪量化per_group算法模式下，对输入weight进行反量化计算的groupSize输入，描述一组反量化参数对应的待反量化数据量在Reduce方向的大小。当伪量化算法模式不为per_group时传入0；当伪量化算法模式为per_group时传入值的范围为[32,k-1]且值要求是32的倍数。

  • y(aclTensor*, 计算输出)：计算输出，公式中的y。当quantScaleOptional存在时，数据类型为INT8；当quantScaleOptional不存在时，数据类型支持FLOAT16、BFLOAT16，且与输入x的数据类型一致。维度支持二维，shape支持(m, n)。undefined支持ND。不支持undefined。

  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。

  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  说明 第一段接口完成入参校验，若出现以下错误码，则对应原因为：

  • 返回161001 (ACLNN_ERR_PARAM_NULLPTR)：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。
  • 返回161002 (ACLNN_ERR_PARAM_INVALID)：原因有：
    • 传入x、weight、antiquantScale、antiquantOffsetOptional、quantScaleOptional、quantOffsetOptional、biasOptional、y的shape维度不符合要求。
    • 传入x、weight、antiquantScale、antiquantOffsetOptional、quantScaleOptional、quantOffsetOptional、biasOptional、y的数据类型不在支持的范围之内。
    • x、weight的reduce维度(k)不相等。
    • antiquantOffsetOptional存在输入时，shape与antiquantScale不相同。
    • quantOffsetOptional存在输入时，shape与quantScale不相同。
    • biasOptional的shape不符合要求。
    • antiquantGroupSize值不符合要求。
    • quantOffsetOptional存在时，quantScaleOptional是空指针。
    • 输入的k、n值不在[1, 65535]范围内；
    • x矩阵为非转置时，m不在[1, 2^31-1]范围内；转置时，m不在[1, 65535]范围内
    • 不支持空tensor场景。
    • 输入tensor的undefined不在支持范围内。
    • 传入x、weight、antiquantScale、antiquantOffsetOptional、quantScaleOptional、quantOffsetOptional、biasOptional、y的连续性不符合要求。
  • 返回361001(ACLNN_ERR_RUNTIME_ERROR): SocVersion不支持。

aclnnWeightQuantBatchMatmulV2

• 参数说明

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

• 返回值：

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

约束与限制

per_channel模式: 为提高性能，推荐使用transpose后的weight输入。m范围为[65,96]时，推荐使用数据类型为UINT64的antiquantScale。

调用示例

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