aclnnConvolution

支持的产品型号

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

接口原型

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

• aclnnStatus aclnnConvolutionGetWorkspaceSize( const aclTensor *input, const aclTensor *weight, const aclTensor *bias, const aclIntArray *stride, const aclIntArray *padding, const aclIntArray *dilation, bool transposed, const aclIntArray *outputPadding, const int64_t groups, aclTensor *output, int8_t cubeMathType, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnConvolution(void* workspace, const uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

• 算子功能：实现卷积功能，支持1D卷积，2D卷积，3D卷积，同时支持转置卷积、空洞卷积、分组卷积。 对于入参transposed = True时，表示使用转置卷积或者分数步长卷积。它可以看作是普通卷积的梯度或者逆向操作，即从卷积的输出形状恢复到输入形状，同时保持与卷积相容的连接模式。它的参数和普通卷积类似，包括输入通道数、输出通道数、卷积核大小、步长、填充、输出填充、分组、偏置、扩张等。

• 计算公式：

  我们假定输入（input）的shape是 $(N, C_{\text{in}}, H, W)$ ,输出（output）的shape是 $(N, C_{\text{out}}, H_{\text{out}}, W_{\text{out}})$，那输出将被表示为：

  $$\text{out}(N_i, C_{\text{out}_j}) = \text{bias}(C_{\text{out}_j}) + \sum_{k = 0}^{C_{\text{in}} - 1} \text{weight}(C_{\text{out}_j}, k) \star \text{input}(N_i, k)$$

  其中，$\star$表示互相关的计算，根据卷积输入的dim，卷积的类型（空洞卷积、分组卷积）而定。$N$代表batch size，$C$代表通道数，$W$和$H$分别代表宽和高。

aclnnConvolutionGetWorkspaceSize

• 参数说明：

  • input(aclTensor *, 计算输入)：公式中的input，支持非连续的Tensor， 数据格式为NCL，NCHW，NCDHW。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT，FLOAT16，BFLOAT16，conv1d、conv2d和conv3d transposed=true场景，各个维度的大小应该在[1,2147483646]的范围内。
    • Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
  • weight(aclTensor *, 计算输入)：公式中的weight，支持非连续的Tensor， 数据格式为NCL，NCHW，NCDHW。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型仅支持FLOAT，FLOAT16，BFLOAT16。conv2d和conv3d transposed=true场景，H、W的大小应该在[1,255]的范围内，其他维度的大小应该在[1,2147483646]的范围内。conv1d transposed=true场景，L的大小应该在[1,255]的范围内，其他维度的大小应该在[1,2147483646]的范围内。
    • Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
  • bias(aclTensor *, 计算输入)：公式中的bias，支持非连续的Tensor，数据格式为NCL，NCHW，NCDHW, ND（Transpose卷积下格式只能是ND，当transposed=false情况下的conv1d、conv2d卷积格式只支持一维且数值与weight第一维相等）。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型仅支持BFLOAT16，FLOAT，FLOAT16。conv1d/conv2d正向场景下会转成FLOAT参与计算。
    • Atlas 推理系列产品：数据类型支持FLOAT，FLOAT16（conv2d正向场景下会直接以FLOAT16格式与输入规格下不带bias的conv2d FLOAT16运算结果进行相加，得到最终带bias的conv2d结果）。
    • Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
  • stride(aclIntArray *, 计算输入)：卷积扫描步长，数组长度需等于input的维度减2。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：conv3d transposed=true场景，strideD应该在[1,2147483646]的范围内，strideH、strideW应该在[1,63]的范围内。conv1d和conv2d transposed=true场景，各个值都应该在[1,2147483646]的范围内。
  • padding(aclIntArray *, 计算输入)：对input的填充，对于conv1d非转置卷积的数组长度可以为1或者2；对于conv2d数组长度可以为2或者4；conv3d数组长度可以为3。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：conv3d transposed=true场景，paddingD应该在[0,2147483646]的范围内，paddingH、paddingW应该在[0,255]的范围内。conv1d和conv2d transposed=false场景，各个值都应该在[0,255]的范围内。
  • dilation(aclIntArray *, 计算输入)：卷积核中元素的间隔，数组长度需等于input的维度减2。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：conv1d、conv2d和conv3d transposed=true场景，各个值都应该在[1,255]的范围内。
  • transposed(bool, 计算输入)：是否为转置卷积。
  • outputPadding(aclIntArray *, 计算输入)：转置卷积情况下，对输出所有边的填充，数组长度需等于input的维度减2。
  • groups(int64_t, 计算输入)：表示从输入通道到输出通道的块链接个数，数值必须大于0，且满足groups*weight的C维度=input的C维度。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：conv1d、conv2d和conv3d transposed=true场景，groups应该在[1,65535]的范围内。
  • cubeMathType(int8_t, 计算输入)：用于判断Cube单元应该使用哪种计算逻辑进行运算，INT8类型的枚举值，枚举如下：
    • 0:KEEP_DTYPE，保持输入的数据类型进行计算。
      • Atlas 训练系列产品、Atlas 推理系列产品：当输入是FLOAT，暂不支持，取0时会报错。
    • 1:ALLOW_FP32_DOWN_PRECISION，允许将输入数据降精度计算。
      • Atlas 训练系列产品、Atlas 推理系列产品：当输入是FLOAT，允许转换为FLOAT16计算。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：允许转换为HFLOAT32计算。
    • 2:USE_FP16，允许转换为数据类型FLOAT16进行计算。当输入数据类型是FLOAT时，转换为FLOAT16计算。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：当输入是BFLOAT16，转换成FLOAT16计算。
    • 3:USE_HF32，允许转换为数据类型HFLOAT32计算。当输入是FLOAT16，昇腾AI处理器仍使用FLOAT16计算。
      • Atlas 训练系列产品、Atlas 推理系列产品：当输入是FLOAT，暂不支持，取3时会报错。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：当输入是FLOAT，转换为HFLOAT32计算。当输入是BFLOAT16，仍使用BFLOAT16计算。
  • output(aclTensor *, 计算输出)：公式中的out，数据格式为NCL，NCHW，NCDHW。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型仅支持FLOAT，FLOAT16，BFLOAT16。
    • Atlas 训练系列产品、Atlas 推理系列产品：数据类型支持FLOAT，FLOAT16。
  • workspaceSize(uint64_t *, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  第一段接口完成入参校验，出现以下场景时报错：
  161001 ACLNN_ERR_PARAM_NULLPTR: 1. 传入的指针类型入参是空指针。
  161002 ACLNN_ERR_PARAM_INVALID: 1. input，weight，bias，output数据类型和数据格式不在支持的范围之内。
                                  2. stride, padding, dilation, outputPadding 输入shape不对。
                                  3. input和output数据类型不一致；卷积正向算子支持input和output数据类型不一致，不会触发该类型报错。
                                  4. groups为0或者大于0的情况下，weight和input通道数不满足要求。
                                  5. output的shape不满足infershape结果。
                                  6. outputPadding值不满足要求, 其应满足大于等于0，且小于stride和dilation对应维度的值。
                                  7. input传入空tensor中任意维度为零的均不满足要求。
                                  8. input空间尺度在padding操作后小于weight(经过dilation扩张（如存在dilation>1的情况）)的空间尺度（非transpose模式下）。
                                  9. transpose模式下bias的shape不为1。
                                  10. stride, dilation小于0情况下不满足要求。
  561103 ACLNN_ERR_INNER_NULLPTR: 1. API内部校验错误，通常由于输入数据或属性的规格不在支持的范围之内导致。

aclnnConvolution

• 参数说明：

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

• 返回值：

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

约束与限制

• Atlas 推理系列产品: 当前仅支持1D和2D卷积，暂不支持3D卷积。
• Atlas 训练系列产品: 支持1D和2D卷积，3D卷积仅支持transposed为false且输入数据类型为FLOAT16场景。
• 由于硬件资源限制，算子在部分参数取值组合场景下会执行失败，请根据日志信息提示分析并排查问题。若无法解决，请单击Link获取技术支持。

调用示例

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

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

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

#define CHECK_FREE_RET(cond, return_expr) \
  do {                                     \
      if (!(cond)) {                       \
          Finalize(deviceId, stream);      \
          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 shape_size = 1;
    for (auto i: shape) {
        shape_size *= i;
    }
    return shape_size;
}

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_NCHW,
                            shape.data(), shape.size(), *deviceAddr);
  return 0;
}

void Finalize(int32_t deviceId, aclrtStream& stream)
{
  aclrtDestroyStream(stream);
  aclrtResetDevice(deviceId);
  aclFinalize();
}

int aclnnConvolutionTest(int32_t deviceId, aclrtStream& stream)
{
  auto ret = Init(deviceId, &stream);
  // check根据自己的需要处理
  CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

  // 2. 构造输入与输出，需要根据API的接口自定义构造
  std::vector<int64_t> shapeInput = {2, 2, 2, 2};
  std::vector<int64_t> shapeWeight = {1, 2, 1, 1};
  std::vector<int64_t> shapeResult = {2, 1, 4, 4};
  std::vector<int64_t> convStrides;
  std::vector<int64_t> convPads;
  std::vector<int64_t> convOutPads;
  std::vector<int64_t> convDilations;

  void* deviceDataA = nullptr;
  void* deviceDataB = nullptr;
  void* deviceDataResult = nullptr;

  aclTensor* input = nullptr;
  aclTensor* weight = nullptr;
  aclTensor* result = nullptr;
  std::vector<float> inputData(GetShapeSize(shapeInput), 1);
  std::vector<float> weightData(GetShapeSize(shapeWeight), 1);
  std::vector<float> outputData(GetShapeSize(shapeResult), 1);
  convStrides = {1, 1, 1, 1};
  convPads = {1, 1, 1, 1};
  convOutPads = {1, 1, 1, 1};
  convDilations = {1, 1, 1, 1};

  // 创建input aclTensor
  ret = CreateAclTensor(inputData, shapeInput, &deviceDataA, aclDataType::ACL_FLOAT, &input);
  std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor *)> inputTensorPtr(input, aclDestroyTensor);
  std::unique_ptr<void, aclError (*)(void *)> deviceDataAPtr(deviceDataA, aclrtFree);
  CHECK_FREE_RET(ret == ACL_SUCCESS, return ret);

  // 创建weight aclTensor
  ret = CreateAclTensor(weightData, shapeWeight, &deviceDataB, aclDataType::ACL_FLOAT, &weight);
  std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor *)> weightTensorPtr(weight, aclDestroyTensor);
  std::unique_ptr<void, aclError (*)(void *)> deviceDataBPtr(deviceDataB, aclrtFree);
  CHECK_FREE_RET(ret == ACL_SUCCESS, return ret);

  // 创建out aclTensor
  ret = CreateAclTensor(outputData, shapeResult, &deviceDataResult, aclDataType::ACL_FLOAT, &result);
  std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor *)> outputTensorPtr(result, aclDestroyTensor);
  std::unique_ptr<void, aclError (*)(void *)> deviceDataResultPtr(deviceDataResult, aclrtFree);
  CHECK_FREE_RET(ret == ACL_SUCCESS, return ret);

  aclIntArray *strides = aclCreateIntArray(convStrides.data(), 2);
  std::unique_ptr<aclIntArray, aclnnStatus (*)(const aclIntArray *)> stridesPtr(strides, aclDestroyIntArray);
  CHECK_FREE_RET(strides != nullptr, return ACL_ERROR_INTERNAL_ERROR);
  aclIntArray *pads = aclCreateIntArray(convPads.data(), 2);
  std::unique_ptr<aclIntArray, aclnnStatus (*)(const aclIntArray *)> padsPtr(pads, aclDestroyIntArray);
  CHECK_FREE_RET(pads != nullptr, return ACL_ERROR_INTERNAL_ERROR);
  aclIntArray *outPads = aclCreateIntArray(convOutPads.data(), 2);
  std::unique_ptr<aclIntArray, aclnnStatus (*)(const aclIntArray *)> outPadsPtr(outPads, aclDestroyIntArray);
  CHECK_FREE_RET(outPads != nullptr, return ACL_ERROR_INTERNAL_ERROR);
  aclIntArray *dilations = aclCreateIntArray(convDilations.data(), 2);
  std::unique_ptr<aclIntArray, aclnnStatus (*)(const aclIntArray *)> dilationsPtr(dilations, aclDestroyIntArray);
  CHECK_FREE_RET(dilations != nullptr, return ACL_ERROR_INTERNAL_ERROR);

  // 3. 调用CANN算子库API，需要修改为具体的API
  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;
  // 调用aclnnConvolution第一段接口
  ret = aclnnConvolutionGetWorkspaceSize(input, weight, nullptr, strides, pads, dilations, false, outPads, 1, result, 1, &workspaceSize, &executor);
  CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnConvolutionGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
  // 根据第一段接口计算出的workspaceSize申请device内存
  void* workspaceAddr = nullptr;
  std::unique_ptr<void, aclError (*)(void *)> workspaceAddrPtr(nullptr, aclrtFree);
  if (workspaceSize > 0) {
    ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
    workspaceAddrPtr.reset(workspaceAddr);
  }
  // 调用aclnnConvolution第二段接口
  ret = aclnnConvolution(workspaceAddr, workspaceSize, executor, stream);
  CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnConvolution failed. ERROR: %d\n", ret); return ret);

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

  // 5. 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
  auto size = GetShapeSize(shapeResult);
  std::vector<float> resultData(size, 0);
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), deviceDataResult,
                    size * sizeof(float), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_FREE_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]);
  }
  
  return ACL_SUCCESS;
}

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

  Finalize(deviceId, stream);
  return 0;
}