aclnnGroupedMatmulV4

支持的产品型号

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

接口原型

每个算子分为undefined，必须先调用“aclnnGroupedMatmulV4GetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnGroupedMatmulV4”接口执行计算。

• aclnnStatus aclnnGroupedMatmulV4GetWorkspaceSize(const aclTensorList *x, const aclTensorList *weight, const aclTensorList *biasOptional, const aclTensorList *scaleOptional, const aclTensorList *offsetOptional, const aclTensorList *antiquantScaleOptional, const aclTensorList *antiquantOffsetOptional, const aclTensorList *perTokenScaleOptional, const aclTensor *groupListOptional, const aclTensorList *activationInputOptional, const aclTensorList *activationQuantScaleOptional, const aclTensorList *activationQuantOffsetOptional, int64_t splitItem, int64_t groupType, int64_t groupListType, int64_t actType, aclTensorList *out, aclTensorList *activationFeatureOutOptional, aclTensorList *dynQuantScaleOutOptional, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnGroupedMatmulV4(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

• 算子功能：实现分组矩阵乘计算，每组矩阵乘的维度大小可以不同。基本功能为矩阵乘，如$y_i[m_i,n_i]=x_i[m_i,k_i] /times weight_i[k_i,n_i], i=1...g$，其中g为分组个数，$m_i/k_i/n_i$为应对shape。输入输出数据类型均为aclTensorList，支持aclTensorList长度为1，对应的功能为：

  • k轴分组：$k_i$各不相同，但$m_i/n_i$每组相同，此时$x_i/weight_i$可以在$k_i$上拼接，对应aclTensorList长度为1。
  • m轴分组：$k_i$各组相同，$weight_i/y_i$可以在$n_i$上拼接。
  • n轴分组：$k_i$各组相同，$x_i/weight_i$分别可以在$m_i/n_i​$上拼接。

相较于undefined接口，此接口新增： - 支持静态量化（pertensor+perchannel）bfloat16输出，带激活及不带激活场景 - 支持动态量化（pertoken+perchannel）bfloat16和float16输出，带激活及不带激活场景。 - 支持groupListOptional中数值为分组轴上每组大小。

• 计算公式：
  • 非量化场景：
  $$y_i=x_i\times weight_i + bias_i$$
  • 量化场景 (per-channel)：
  $$y_i=(x_i\times weight_i + bias_i) * scale_i + offset_i$$
  • 量化场景 (per-token)：
  $$y_i=(x_i\times weight_i + bias_i) * scale_i * per_token_scale_i$$
  • 反量化场景：
  $$y_i=(x_i\times weight_i + bias_i) * scale_i$$
  • 伪量化场景：
  $$y_i=x_i\times (weight_i + antiquant\_offset_i) * antiquant\_scale_i + bias_i$$

aclnnGroupedMatmulV4GetWorkspaceSize

• 参数说明：

  • x（aclTensorList*，计算输入）：必选参数，Device侧的aclTensorList，公式中的输入x，数据类型支持FLOAT16、BFLOAT16、INT8、FLOAT32，undefined支持ND，支持的最大长度为128个。
  • weight（aclTensorList*，计算输入）：必选参数，Device侧的aclTensorList，公式中的weight，数据类型支持FLOAT16、BFLOAT16、INT8、FLOAT32，undefined支持ND，支持的最大长度为128个。
  • biasOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，公式中的bias，数据类型支持FLOAT16、FLOAT32、INT32，undefined支持ND，长度与weight相同。
  • scaleOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，代表量化参数中的缩放因子，数据类型支持UINT64、BFLOAT16，undefined支持ND，长度与weight相同。
  • offsetOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，代表量化参数中的偏移量，数据类型支持FLOAT32，undefined支持ND，长度与weight相同。
  • antiquantScaleOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，代表伪量化参数中的缩放因子，数据类型支持FLOAT16、BFLOAT16，undefined支持ND，长度与weight相同。
  • antiquantOffsetOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，代表伪量化参数中的偏移量，数据类型支持FLOAT16、BFLOAT16，undefined支持ND，长度与weight相同。
  • perTokenScaleOptional（aclTensorList*，计算输入）可选参数，Device侧的aclTensorList，代表量化参数中的由x量化引入的缩放因子，数据类型支持FLOAT32，undefined支持ND，只支持1维且长度与x相同。
  • groupListOptional（aclTensor*，计算输入）：可选参数，Host侧的aclTensor类型，代表输入和输出分组轴方向的matmul大小分布，数据类型支持INT64，undefined支持ND。
  • activationInputOptional（aclTensorList*，计算输入）：可选参数，Host侧的aclTensorList类型，代表激活函数的反向输入，当前只支持传入nullptr。
  • activationQuantScaleOptional*，计算输入）：可选参数，Host侧的aclTensorList类型，当前只支持传入nullptr。
  • activationQuantOffsetOptional*，计算输入）：可选参数，Host侧的aclTensorList类型，当前只支持传入nullptr。
  • splitItem（int64_t，计算输入）：整数型参数，代表输出是否要做tensor切分，0/1代表输出为多tensor；2/3代表输出为单tensor。
  • groupType（int64_t，计算输入）：整数型参数，代表需要分组的轴，如矩阵乘为C[m,n]=A[m,k]xB[k,n]，则groupType取值-1：不分组，0：m轴分组，1：n轴分组，2：k轴分组，当前不支持n轴分组。
  • groupListType（int64_t，计算输入）：整数型参数，可取值0或1，0代表groupListOptional中数值为分组轴大小的cumsum结果（累积和），1代表groupListOptional中数值为分组轴上每组大小。
  • actType（int64_t，计算输入）：整数型参数，代表激活函数类型，取值范围为0-5，支持的枚举值如下：
  • 0：GMMActType::GMM_ACT_TYPE_NONE；
  • 1：GMMActType::GMM_ACT_TYPE_RELU；
  • 2：GMMActType::GMM_ACT_TYPE_GELU_TANH；
  • 3：GMMActType::GMM_ACT_TYPE_GELU_ERR_FUNC（不支持）；
  • 4：GMMActType::GMM_ACT_TYPE_FAST_GELU；
  • 5：GMMActType::GMM_ACT_TYPE_SILU；
  • out（aclTensorList*，计算输出）：Device侧的aclTensorList，公式中的输出y，数据类型支持FLOAT16、BFLOAT16、INT8、FLOAT32，undefined支持ND，支持的最大长度为128个。
  • activationFeatureOutOptional（aclTensorList*，计算输出）：Device侧的aclTensorList，激活函数的输入数据，当前只支持传入nullptr。
  • dynQuantScaleOutOptional*，计算输出）：Device侧的aclTensorList，当前只支持传入nullptr。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnGroupedMatmulV4

• 参数说明：

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

• 返回值：

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

约束与限制

• 非量化场景支持的输入类型为：

  • x为FLOAT16、weight为FLOAT16、biasOptional为FLOAT16、scaleOptional为空、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为空、activationInputOptional为空、y为FLOAT16；
  • x为BFLOAT16、weight为BFLOAT16、biasOptional为FLOAT32、scaleOptional为空、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为空、activationInputOptional为空、y为BFLOAT16；
  • x为FLOAT32、weight为FLOAT32、biasOptional为FLOAT32、scaleOptional为空、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为空、activationInputOptional为空、y为FLOAT32（仅x、weight、y都为单tensor场景支持）；

• per-channel量化场景支持的输入类型为：

  • x为INT8、weight为INT8、biasOptional为INT32、scaleOptional为UINT64、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为空、activationInputOptional为空、y为INT8；

• per-token量化场景支持的输入类型为：

  • x为INT8、weight为INT8、biasOptional为INT32、scaleOptional为BFLOAT16、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为FLOAT32、activationInputOptional为空、y为BFLOAT16；
  • x为INT8、weight为INT8、biasOptional为INT32、scaleOptional为FLOAT32、offsetOptional为空、antiquantScaleOptional为空、antiquantOffsetOptional为空、perTokenScaleOptional为FLOAT32、activationInputOptional为空、y为FLOAT16；

• 伪量化场景支持的输入类型为：

  • x为FLOAT16、weight为INT8、biasOptional为FLOAT16、scaleOptional为空，offsetOptional为空，antiquantScaleOptional为FLOAT16、antiquantOffsetOptional为FLOAT16、perTokenScaleOptional为空、activationInputOptional为空、y为FLOAT16；
  • x为BFLOAT16、weight为INT8、biasOptional为FLOAT32、scaleOptional为空，offsetOptional为空，antiquantScaleOptional为BFLOAT16、antiquantOffsetOptional为BFLOAT16、perTokenScaleOptional为空、activationInputOptional为空、y为BFLOAT16；

• 在Atlas 推理系列产品上运行时，输入输出只支持float16的数据类型，输出y的n轴大小需要是16的倍数。

• 如果传入groupListOptional，当groupListType为0时，groupListOptional必须为非负单调非递减数列，当groupListType为1时，groupListOptional必须为非负数列，且长度不能为1。

• 不同groupType支持场景:

  • 量化、伪量化仅支持groupType为-1和0场景。
  • 支持场景中单表示单tensor，多表示多tensor，表示顺序为x，weight，y，例如单多单表示支持x为单tensor，weight多tensor，y单tensor的场景。

  groupType	支持场景	场景限制
  -1	多多多	1）仅支持splitItem为0/1[object Object]2）x中tensor支持2-6维，weight中tensor需为2维，y中tensor维度和x保持一致[object Object]3）groupListOptional必须传空
  0	单单单	1）仅支持splitItem为2/3[object Object]2）weight中tensor需为3维，x，y中tensor需为2维[object Object]3）必须传groupListOptional，且当groupListType为0时，最后一个值与x中tensor的第一维相等，当groupListType为1时，数值的总和与x中tensor的第一维相等[object Object]4）groupListOptional最大长度为1024
  0	单多单	1）仅支持splitItem为2/3[object Object]2）必须传groupListOptional，且当groupListType为0时，最后一个值与x中tensor的第一维相等，当groupListType为1时，数值的总和与x中tensor的第一维相等，长度最大为128[object Object]3）x,weight,y中tensor需为2维[object Object]4）weight中每个tensor的N轴必须相等
  0	多多单	1）仅支持splitItem为2/3[object Object]2）x,weight,y中tensor需为2维[object Object]3）weight中每个tensor的N轴必须相等[object Object]4）若传入groupListOptional，当groupListType为0时，groupListOptional的差值需与x中tensor的第一维一一对应，当groupListType为1时，groupListOptional的数值需与x中tensor的第一维一一对应，且长度最大为128
  2	单单单	1）仅支持splitItem为2/3[object Object]2）x，weight中tensor需为2维，y中tensor需为3维[object Object]3）必须传groupListOptional，且当groupListType为0时，最后一个值与x中tensor的第二维相等，当groupListType为1时，数值的总和与x中tensor的第二维相等[object Object]4）groupListOptional最大长度为1024

  其中Atlas 推理系列产品仅支持x为单tensor，weight为单tensor，y为单tensor，且groupType为0的转置与非转置场景。

• x和weight中每一组tensor的最后一维大小都应小于65536。$x_i$的最后一维指当属性transpose_x为false时$x_i$的K轴或当transpose_x为true时$x_i$的M轴。$weight_i$的最后一维指当属性transpose_weight为false时$weight_i$的N轴或当transpose_weight为true时$weight_i$的K轴。

• x和weight中每一组tensor的每一维大小在32字节对齐后都应小于int32的最大值2147483647。

• 仅量化场景 (per-token)、反量化场景支持激活函数计算。

调用示例

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