aclnnAddmm&aclnnInplaceAddmm

支持的产品型号

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

接口原型

aclnnAddmm和aclnnInplaceAddmm实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。
- aclnnAddmm：需新建一个输出张量对象存储计算结果。
- aclnnInplaceAddmm：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。
每个算子分为两段式接口，必须先调用 “aclnnAddmmGetWorkspaceSize” 或者 “aclnnInplaceAddmmGetWorkspaceSize” 接口获取入参并根据计算流程计算所需workspace大小，再调用 “aclnnAddmm” 或者 “aclnnInplaceAddmm” 接口执行计算。
- aclnnStatus aclnnAddmmGetWorkspaceSize(const aclTensor* self, const aclTensor* mat1, const aclTensor* mat2, const aclScalar* beta, const aclScalar* alpha, aclTensor* out, int8_t cubeMathType, uint64_t* workspaceSize, aclOpExecutor** executor)
- aclnnStatus aclnnAddmm(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)
- aclnnStatus aclnnInplaceAddmmGetWorkspaceSize(const aclTensor* selfRef, const aclTensor* mat1, const aclTensor* mat2, const aclScalar* beta, const aclScalar* alpha, int8_t cubeMathType, uint64_t* workspaceSize, aclOpExecutor** executor)
- aclnnStatus aclnnInplaceAddmm(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)

功能描述

算子功能：计算α 乘以mat1与mat2的乘积，再与β和self的乘积求和。
计算公式：

out = β self + α (mat1 @ mat2)

示例：
- 对于aclnnAddmm接口，self的shape是[1, n], mat1的shape是[m, k], mat2的shape是[k, n], mat1和mat2的矩阵乘的结果shape是[m, n], self的shape能broadcast到[m, n]。
- 对于aclnnAddmm接口，self的shape是[m, 1], mat1的shape是[m, k], mat2的shape是[k, n], mat1和mat2的矩阵乘的结果shape是[m, n], self的shape能broadcast到[m, n]。
- 对于aclnnAddmm接口，self的shape是[m, n], mat1的shape是[m, k], mat2的shape是[k, n], mat1和mat2的矩阵乘的结果shape是[m, n]。
- 对于aclnnInplaceAddmm接口，直接在输入张量selfRef的内存中存储计算结果，self的shape是[m, n], mat1的shape是[m, k], mat2的shape是[k, n]。

aclnnAddmmGetWorkspaceSize

参数说明：
- self（aclTensor*, 计算输入）：表示公式中的self, Device侧的aclTensor，数据类型需要与 $mat1@mat2$ $ma t 1@ ma t 2$ 构成互相推导关系（参见互推导关系和约束与限制），shape需要满足能够broadcast成 $mat1@mat2$ $ma t 1@ ma t 2$ 的结果shape。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- mat1（aclTensor*, 计算输入）：Device侧的aclTensor，且数据类型需要与self，mat2构成互相推导关系（参见互推导关系和约束与限制），shape仅支持二维且需要满足与mat2相乘条件。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- mat2（aclTensor*, 计算输入）：Device侧的aclTensor，且数据类型需要与self，mat1构成互相推导关系（参见互推导关系和约束与限制），shape仅支持二维且需要满足与mat1相乘条件。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- beta(β)(aclScalar, 计算输入)：Host侧的aclScalar，数据类型支持FLOAT、FLOAT16、DOUBLE、INT8、INT16、INT32、INT64、UINT8。
- alpha(α)(aclScalar, 计算输入)：Host侧的aclScalar，数据类型支持FLOAT、FLOAT16、DOUBLE、INT8、INT16、INT32、INT64、UINT8。
- out（aclTensor*, 计算输出）：Device侧的aclTensor，且数据类型需要与self构成互相推导关系，shape需要与 $mat1@mat2$ $ma t 1@ ma t 2$ 一致，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- cubeMathType(int8_t，计算输入)：Host侧的整型，判断Cube单元应该使用那种计算逻辑进行运算，数据类型支持INT8，注意：如果输入的数据类型存在互相推导关系，该参数默认对推导后的数据类型进行处理。具体的枚举值如下：
  - 0：KEEP_DTYPE，保持输入的数据类型进行计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：输入的数据类型支持FLOAT16, 当输入是FLOAT32时不支持该选项。
  - 1：ALLOW_FP32_DOWN_PRECISION，支持将输入数据降精度计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，会使能HFLOAT32计算；当数据为其他数据类型时，保持输入类型计算。
  - 2：USE_FP16，支持将输入降为FLOAT16精度计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
  - 3：USE_HF32，支持转换数据类型HFLOAT32计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：不支持该选项。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，会使能HFLOAT32计算；当数据为其他数据类型时，不支持该选项。
- workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。
返回值：

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

第一段接口完成入参校验，出现如下场景时报错：
161001(ACLNN_ERR_PARAM_NULLPTR)：1. 传入的self、mat1、mat2或out是空指针。
161002(ACLNN_ERR_PARAM_INVALID)：1. self和mat2的数据类型和数据格式不在支持的范围之内。
                                 2. mat1和mat2不满足相乘条件。
                                 3. out和 mat1@mat2 shape不一致。

aclnnAddmm

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

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

aclnnInplaceAddmmGetWorkspaceSize

参数说明：
- selfRef（aclTensor*, 计算输入|计算输出）：即公式中的输入self与out，Device侧的aclTensor，数据类型需要与 $mat1@mat2$ $ma t 1@ ma t 2$ 构成互相推导关系（参见互推导关系和约束与限制），shape需要与 $mat1@mat2$ $ma t 1@ ma t 2$ 的结果shape保持一致。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- mat1（aclTensor*, 计算输入）：Device侧的aclTensor，数据类型需要与selfRef，mat2构成互相推导关系（参见互推导关系和约束与限制），shape仅支持二维且需要满足与mat2相乘条件。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- mat2（aclTensor*, 计算输入）：Device侧的aclTensor，数据类型需要与selfRef，mat1构成互相推导关系（参见互推导关系和约束与限制），shape仅支持二维且需要满足与mat1相乘条件。支持非连续的Tensor，数据格式支持ND。
  - Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
  - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。
- beta(β)(aclScalar, 计算输入)：Host侧的aclScalar，数据类型支持FLOAT、FLOAT16、DOUBLE、INT8、INT16、INT32、INT64、UINT8。
- alpha(α)(aclScalar, 计算输入)：Host侧的aclScalar，数据类型支持FLOAT、FLOAT16、DOUBLE、INT8、INT16、INT32、INT64、UINT8。
- cubeMathType(int8_t，计算输入)：Host侧的整型，判断Cube单元应该使用那种计算逻辑进行运算，数据类型支持INT8，注意：如果输入的数据类型存在互相推导关系，该参数默认对推导后的数据类型进行处理。具体的枚举值如下：
  - 0：KEEP_DTYPE，保持输入的数据类型进行计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：输入的数据类型支持FLOAT16, 当输入是FLOAT32时不支持该选项。
  - 1：ALLOW_FP32_DOWN_PRECISION，支持将输入数据降精度计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，会使能HFLOAT32计算；当数据为其他数据类型时，保持输入类型计算。
  - 2：USE_FP16，支持将输入降为FLOAT16精度计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，转换为FLOAT16计算；当数据为其他数据类型时，保持输入类型计算。
  - 3：USE_HF32，支持转换数据类型HFLOAT32计算。
    - Atlas 训练系列产品、Atlas 推理系列产品：不支持该选项。
    - Atlas A2 训练系列产品/Atlas 800I A2 推理产品：当输入数据类型是FLOAT32，会使能HFLOAT32计算；当数据为其他数据类型时，不支持该选项。
- workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。
返回值：

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

第一段接口完成入参校验，出现如下场景时报错：
161001(ACLNN_ERR_PARAM_NULLPTR)：1. 传入的selfRef、mat1或mat2是空指针。
161002(ACLNN_ERR_PARAM_INVALID)：1. selfRef和mat2的数据类型和数据格式不在支持的范围之内。
                                 2. mat1和mat2不满足相乘条件。
                                 3. selfRef和 mat1@mat2 shape不一致。

aclnnInplaceAddmm

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

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

约束与限制

Atlas A2 训练系列产品/Atlas 800I A2 推理产品：不支持mat1和mat2两输入其中一个输入为BFLOAT16, 另一个输入为FLOAT或FLOAT16的数据类型推导。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_addmm.h"

#define CHECK_RET(cond, return_expr) \
  do {                               \
    if (!(cond)) {                   \
      return_expr;                   \
    }                                \
  } while (0)

#define LOG_PRINT(message, ...)     \
  do {                              \
    printf(message, ##__VA_ARGS__); \
  } while (0)

int64_t GetShapeSize(const std::vector<int64_t>& shape) {
  int64_t shapeSize = 1;
  for (auto i : shape) {
    shapeSize *= i;
  }
  return shapeSize;
}

int Init(int32_t deviceId, aclrtStream* stream) {
  // 固定写法，AscendCL初始化
  auto ret = aclInit(nullptr);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
  ret = aclrtSetDevice(deviceId);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
  ret = aclrtCreateStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);
  return 0;
}

template <typename T>
int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr,
                    aclDataType dataType, aclTensor** tensor) {
  auto size = GetShapeSize(shape) * sizeof(T);
  // 调用aclrtMalloc申请device侧内存
  auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);
  // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上
  ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

  // 计算连续tensor的strides
  std::vector<int64_t> strides(shape.size(), 1);
  for (int64_t i = shape.size() - 2; i >= 0; i--) {
    strides[i] = shape[i + 1] * strides[i + 1];
  }

  // 调用aclCreateTensor接口创建aclTensor
  *tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND,
                            shape.data(), shape.size(), *deviceAddr);
  return 0;
}

int main() {
  // 1. （固定写法）device/stream初始化，参考AscendCL对外接口列表
  // 根据自己的实际device填写deviceId
  int32_t deviceId = 0;
  aclrtStream stream;
  auto ret = Init(deviceId, &stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

  // 2. 构造输入与输出，需要根据API的接口自定义构造
  std::vector<int64_t> selfShape = {2, 4};
  std::vector<int64_t> mat1Shape = {2, 3};
  std::vector<int64_t> mat2Shape = {3, 4};
  std::vector<int64_t> outShape = {2, 4};
  void* selfDeviceAddr = nullptr;
  void* mat1DeviceAddr = nullptr;
  void* mat2DeviceAddr = nullptr;
  void* outDeviceAddr = nullptr;
  aclTensor* self = nullptr;
  aclTensor* mat1 = nullptr;
  aclTensor* mat2 = nullptr;
  aclScalar* alpha = nullptr;
  aclScalar* beta = nullptr;
  aclTensor* out = nullptr;
  std::vector<float> selfHostData = {0, 1, 2, 3, 4, 5, 6, 7};
  std::vector<float> mat1HostData = {1, 1, 1, 2, 2, 2};
  std::vector<float> mat2HostData = {1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4};
  std::vector<float> outHostData(8, 0);
  int8_t cubeMathType = 1;
  float alphaValue = 1.2f;
  float betaValue = 1.0f;
  // 创建self aclTensor
  ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建mat1 aclTensor
  ret = CreateAclTensor(mat1HostData, mat1Shape, &mat1DeviceAddr, aclDataType::ACL_FLOAT, &mat1);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建mat2 aclTensor
  ret = CreateAclTensor(mat2HostData, mat2Shape, &mat2DeviceAddr, aclDataType::ACL_FLOAT, &mat2);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建alpha aclScalar
  alpha = aclCreateScalar(&alphaValue,aclDataType::ACL_FLOAT);
  CHECK_RET(alpha != nullptr, return ret);
  // 创建beta aclScalar
  beta = aclCreateScalar(&betaValue,aclDataType::ACL_FLOAT);
  CHECK_RET(beta != nullptr, return ret);
  // 创建out aclTensor
  ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  // 3. 调用CANN算子库API，需要修改为具体的Api名称
  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;

  // 调用aclnnAddmm第一段接口
  ret = aclnnAddmmGetWorkspaceSize(self, mat1, mat2, beta, alpha, out, cubeMathType, &workspaceSize, &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnAddmmGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
  // 根据第一段接口计算出的workspaceSize申请device内存
  void* workspaceAddr = nullptr;
  if (workspaceSize > 0) {
    ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
  }
  // 调用aclnnAddmm第二段接口
  ret = aclnnAddmm(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnAddmm failed. ERROR: %d\n", ret); return ret);

  // 4. （固定写法）同步等待任务执行结束
  ret = aclrtSynchronizeStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);

  // 5. 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
  auto size = GetShapeSize(outShape);
  std::vector<float> resultData(size, 0);
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr,
                    size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
  for (int64_t i = 0; i < size; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
  }

  // aclnnInplaceAddmm
  // step3 调用CANN算子库API
  LOG_PRINT("\ntest aclnnInplaceAddmm\n");
  // 调用aclnnInplaceAddmm第一段接口
  ret = aclnnInplaceAddmmGetWorkspaceSize(self, mat1, mat2, beta, alpha, cubeMathType, &workspaceSize, &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceAddmmGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
  // 根据第一段接口计算出的workspaceSize申请device内存
  if (workspaceSize > 0) {
    ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
  }
  // 调用aclnnInplaceAddmm第二段接口
  ret = aclnnInplaceAddmm(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceAddmm failed. ERROR: %d\n", ret); return ret);

  // step4（固定写法）同步等待任务执行结束
  ret = aclrtSynchronizeStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);

  // step5 获取输出的值，将device侧内存上的结果拷贝至host侧
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), selfDeviceAddr,
                    size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
  for (int64_t i = 0; i < size; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
  }

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(self);
  aclDestroyTensor(mat1);
  aclDestroyTensor(mat2);
  aclDestroyScalar(beta);
  aclDestroyScalar(alpha);
  aclDestroyTensor(out);

  // 7.释放device资源，需要根据具体API的接口定义修改
  aclrtFree(selfDeviceAddr);
  aclrtFree(mat1DeviceAddr);
  aclrtFree(mat2DeviceAddr);
  aclrtFree(outDeviceAddr);
  if (workspaceSize > 0) {
    aclrtFree(workspaceAddr);
  }
  aclrtDestroyStream(stream);
  aclrtResetDevice(deviceId);
  aclFinalize();

  return 0;
}