aclnnAddbmm&aclnnInplaceAddbmm

产品支持情况

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

功能说明

• 算子功能：首先进行batch1、batch2的矩阵乘计算，然后将该结果按照第一维（batch维度）批处理相加，将三维向量压缩为二维向量（shape大小为后两维的shape），然后该结果与α作乘积计算，再与β和self的乘积求和得到结果。

• 计算公式：

  $$out = βself+α(\sum_{i=0}^{b-1} batch1_{i}@batch2_{i})$$

  注意：如果β为0，则self会被忽略，不参与计算。如果α为0，则batch1和batch2会被忽略，不参与计算。

• 示例：

  self的shape是[3,5]，batch1的shape是[10,3,4]，batch2的shape是[10,4,5]，计算输出out的shape是[3,5]。

函数原型

• aclnnAddbmm和aclnnInplaceAddbmm实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

  • aclnnAddbmm：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceAddbmm：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。

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

  • aclnnStatus aclnnAddbmmGetWorkspaceSize(const aclTensor *self, const aclTensor *batch1, const aclTensor *batch2, const aclScalar *beta, const aclScalar *alpha, aclTensor *out, int8_t cubeMathType, uint64_t *workspaceSize, aclOpExecutor **executor)

  • aclnnStatus aclnnAddbmm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

  • aclnnStatus aclnnInplaceAddbmmGetWorkspaceSize(aclTensor *selfRef, const aclTensor *batch1, const aclTensor *batch2, const aclScalar *beta, const aclScalar *alpha, int8_t cubeMathType, uint64_t *workspaceSize, aclOpExecutor **executor)

  • aclnnStatus aclnnInplaceAddbmm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnAddbmmGetWorkspaceSize

• 参数说明：

  • self（aclTensor*,计算输入）：公式中的输入self，Device侧的aclTensor。数据类型需要与batch1@batch2后的二维数据满足数据类型推导规则（参见undefined和undefined）。shape需要与batch1@batch2的后两维的shape满足undefined（注意：只能是self通过broadcast变成和batch1@batch2的后两维一样的shape，不可以batch1@batch2的后两维通过broadcast变成和self一样，举例：self:[3,5]，batch1@batch2:[1,1,1]，会失败）。支持undefined，支持空Tensor。undefined支持ND。Shape需至少1维，目前不支持标量张量。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • batch1（aclTensor*,计算输入）：公式中的输入batch1，Device侧的aclTensor。数据类型与self、batch2的数据类型需满足数据类型推导规则（参见undefined和undefined），shape仅支持三维且第一个维度batch1需要与batch2的batch维度满足undefined。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • batch2（aclTensor*,计算输入）：公式中的输入batch2，Device侧的aclTensor。数据类型与self、batch1的数据类型需满足数据类型推导规则（参见undefined和undefined），shape仅支持三维且第一个维度batch需要与batch1的batch维度满足undefined。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • beta（aclScalar*,计算输入）：公式中的输入β，Host侧的aclScalar。数据类型支持FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL，且数据类型需要可转换成self与batch1@batch2推导后的数据类型（参见undefined和undefined）。
  • alpha（aclScalar*,计算输入）：公式中的输入α，Host侧的aclScalar。数据类型支持FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL，且数据类型需要可转换成self与batch1@batch2推导后的数据类型（参见undefined和undefined）。
  • out（aclTensor*，计算输出）：公式中的输出out，Device侧的aclTensor。数据类型与self、batch1@batch2推导后的数据类型满足数据类型推导规则（参见undefined和undefined）。shape要求与batch1@batch2的后两维shape保持一致。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • cubeMathType（INT8，计算输入）：用于指定Cube单元的计算逻辑，Host侧的整型。数据类型支持INT8。注意：如果输入的数据类型存在互推导关系，该参数默认对互推导后的数据类型进行处理。支持的枚举值如下：
    • 0：KEEP_DTYPE，保持输入的数据类型进行计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：当输入数据类型为FLOAT32时不支持该选项。
    • 1：ALLOW_FP32_DOWN_PRECISION，支持将输入数据降精度计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为FLOAT16计算。当输入为其他数据类型时不做处理。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为HFLOAT32计算。当输入为其他数据类型时不做处理。
    • 2：USE_FP16，支持将输入降精度至FLOAT16计算。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为BFLOAT16时不支持该选项。
    • 3：USE_HF32，支持将输入降精度至数据类型HFLOAT32计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：不支持该选项。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为HFLOAT32计算。当输入为其他数据类型时不支持该选项。

• 返回值：

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

  [object Object]

aclnnAddbmm

• 参数说明：

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

• 返回值：

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

aclnnInplaceAddbmmGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*，计算输入|计算输出）：输入输出tensor，即公式中的输入self与out，Device侧的aclTensor。数据类型与batch1@batch2的数据类型需满足数据类型推导规则（参见undefined和undefined），shape需要与batch1@batch2的后两维的shape一致。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • batch1（aclTensor*,计算输入）：公式中的输入batch1，Device侧的aclTensor。数据类型与self、batch2的数据类型需满足数据类型推导规则（参见undefined和undefined），shape仅支持三维且第一个维度batch需要与batch2的batch维度满足undefined。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • batch2（aclTensor*,计算输入）：公式中的输入batch2，Device侧的aclTensor。数据类型与self、batch1的数据类型需满足数据类型推导规则（参见undefined和undefined），shape仅支持三维且第一个维度batch需要与batch1的batch维度满足undefined。支持undefined，支持空Tensor。undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • beta（aclScalar*,计算输入）：公式中的输入β，Host侧的aclScalar。数据类型支持FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL,且数据类型需要可转换成self与batch1@batch2推导后的数据类型（参见undefined和undefined）。
  • alpha（aclScalar*,计算输入）：公式中的输入α，Host侧的aclScalar。数据类型支持FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL，且数据类型需要可转换成self与batch1@batch2推导后的数据类型（参见undefined和undefined）。
  • cubeMathType（INT8，计算输入）：用于指定Cube单元的计算逻辑，Host侧的整型。数据类型支持INT8。注意：如果输入的数据类型存在互推导关系，该参数默认对互推导后的数据类型进行处理。支持的枚举值如下：
    • 0：KEEP_DTYPE，保持输入的数据类型进行计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：当输入数据类型为FLOAT32时不支持该选项。
    • 1：ALLOW_FP32_DOWN_PRECISION，支持将输入数据降精度计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为FLOAT16计算。当输入为其他数据类型时不做处理。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为HFLOAT32计算。当输入为其他数据类型时不做处理。
    • 2：USE_FP16，支持将输入降精度至FLOAT16计算。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为BFLOAT16时不支持该选项。
    • 3：USE_HF32，支持将输入降精度至数据类型HFLOAT32计算。
      • [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：不支持该选项。
      • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：当输入数据类型为FLOAT32时，会转换为HFLOAT32计算。当输入为其他数据类型时不支持该选项。

• 返回值：

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

  [object Object]

aclnnInplaceAddbmm

• 参数说明：

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

• 返回值：

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

约束说明

• [object Object]Atlas 训练系列产品[object Object]、[object Object]Atlas 推理系列产品[object Object]：Cube单元不支持FLOAT32计算。当输入为FLOAT32，可通过设置cubeMathType=1（ALLOW_FP32_DOWN_PRECISION）来允许接口内部cast到FLOAT16进行计算。
• [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：不支持batch1和batch2两输入其中一个输入为BFLOAT16, 另一个输入为FLOAT或FLOAT16的数据类型推导。

调用示例

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