aclnnConvolution
产品支持情况
| 产品 | 是否支持 |
|---|---|
| Ascend 950PR/Ascend 950DT | √ |
| Atlas A3 训练系列产品/Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品/Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | √ |
| Atlas 推理系列产品 | √ |
| Atlas 训练系列产品 | × |
功能说明
-
接口功能:实现卷积功能,支持1D卷积、2D卷积、3D卷积,同时支持转置卷积、空洞卷积、分组卷积。 对于入参
transposed = True时,表示使用转置卷积或者分数步长卷积。它可以看作是普通卷积的梯度或者逆向操作,即从卷积的输出形状恢复到输入形状,同时保持与卷积相容的连接模式。它的参数和普通卷积类似,包括输入通道数、输出通道数、卷积核大小、步长、填充、输出填充、分组、偏置、扩张等。 -
计算公式:
假定输入(input)的shape是 (N,Cin,D,H,W)(N, C_{\text{in}}, D, H, W),(weight)的shape是 (Cout,Cin,Kd,Kh,Kw)(C_{\text{out}}, C_{\text{in}}, K_d, K_h, K_w),输出(output)的shape是 (N,Cout,Dout,Hout,Wout)(N, C_{\text{out}}, D_{\text{out}}, H_{\text{out}}, W_{\text{out}}),其中 NN 表示批次大小(batch size),CC 是通道数,DD、HH 和 WW 分别是样本的深度、高度和宽度,KdK_d、KhK_h 和 KwK_w 分别是卷积核的深度、高度和宽度,那输出将被表示为:
output(Ni,Coutj,Dout,Hout,Wout)=∑k=0Cin−1weight(Coutj,k)⋆input(Ni,k)+bias(Coutj)\text{output}(N_i, C_{\text{out}_j}, D_{\text{out}}, H_{\text{out}}, W_{\text{out}}) = \sum_{k = 0}^{C_{\text{in}} - 1} \text{weight}(C_{\text{out}_j}, k) \star \text{input}(N_i, k) + \text{bias}(C_{\text{out}_j})
其中,⋆\star 表示卷积计算,根据卷积输入的维度,卷积的类型(空洞卷积、分组卷积)而定。NN 代表批次大小(batch size),CC 代表通道数,DD、HH 和 WW 分别代表深度、高度和宽度,相应输出维度的计算公式如下:
-
对于入参
transposed = False时:Dout=[(D+2×padding[0]−dilation[0]×(Kd−1)−1)/stride[0]]+1Hout=[(H+2×padding[1]−dilation[1]×(Kh−1)−1)/stride[1]]+1Wout=[(W+2×padding[2]−dilation[2]×(Kw−1)−1)/stride[2]]+1D_{\text{out}}=[(D + 2 \times padding[0] - dilation[0] \times (K_d - 1) - 1 ) / stride[0]] + 1 \\ H_{\text{out}}=[(H + 2 \times padding[1] - dilation[1] \times (K_h - 1) - 1 ) / stride[1]] + 1 \\ W_{\text{out}}=[(W + 2 \times padding[2] - dilation[2] \times (K_w - 1) - 1 ) / stride[2]] + 1
-
对于入参
transposed = True时:Dout=(D−1)×stride[0]−2×padding[0]+dilation[0]×(Kd−1)+outputPadding[0]+1Hout=(H−1)×stride[1]−2×padding[1]+dilation[1]×(Kh−1)+outputPadding[1]+1Wout=(W−1)×stride[2]−2×padding[2]+dilation[2]×(Kw−1)+outputPadding[2]+1D_{\text{out}}=(D - 1) \times \text{stride}[0] - 2 \times \text{padding}[0] + \text{dilation}[0] \times (K_d - 1) + \text {outputPadding}[0] + 1 \\ H_{\text{out}}=(H - 1) \times \text{stride}[1] - 2 \times \text{padding}[1] + \text{dilation}[1] \times (K_h - 1) + \text {outputPadding}[1] + 1 \\ W_{\text{out}}=(W - 1) \times \text{stride}[2] - 2 \times \text{padding}[2] + \text{dilation}[2] \times (K_w - 1) + \text {outputPadding}[2] + 1
-
函数原型
每个算子分为两段式接口,必须先调用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)
aclnnConvolutionGetWorkspaceSize
-
参数说明
参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor input(aclTensor*) 输入 公式中的input,表示卷积输入。 FLOAT、FLOAT16、BFLOAT16、HIFLOAT8、FLOAT8_E4M3FN NCL、NCHW、NCDHW 3-5 √ weight(aclTensor*) 输入 公式中的weight,表示卷积权重。 FLOAT、FLOAT16、BFLOAT16、HIFLOAT8、FLOAT8_E4M3FN NCL、NCHW、NCDHW 3-5 √ bias(aclTensor*) 输入 公式中的bias,表示卷积偏置。 - 无bias场景,可传入nullptr。
- 当transposed=false时为一维且数值与weight第一维相等;当transposed=true时为一维且数值与weight.shape[1] * groups相等,format仅支持ND格式。
FLOAT、FLOAT16、BFLOAT16 ND、NCL、NCHW、NCDHW 1-5 √ stride(aclIntArray*) 输入 卷积扫描步长。 数组长度需等于input的维度减2,值应该大于0。 INT64 - - - padding(aclIntArray*) 输入 对input的填充。 数组长度:conv1d非转置为1或2;conv1d转置为1;conv2d为2或4;conv3d为3。值应该大于等于0。 INT64 - - - dilation(aclIntArray*) 输入 卷积核中元素的间隔。 数组长度需等于input的维度减2,值应该大于0。 INT64 - - - transposed(bool) 输入 是否为转置卷积。 - BOOL - - - outputPadding(aclIntArray*) 输入 转置卷积情况下,对输出所有边的填充。 非转置卷积情况下忽略该配置。数组长度需等于input的维度减2。值应大于等于0,且小于stride或dilation对应维度的值。 INT32 - - - groups(int64_t) 输入 表示从输入通道到输出通道的块链接个数。 数值需要在[1,65535]的范围内,且满足groups*weight的C维度=input的C维度。 INT64 - - - output(aclTensor*) 输出 公式中的out,表示卷积输出。 - 支持空Tensor。
- 数据类型需要与input与weight推导之后的数据类型保持一致。
- 通道数等于weight第一维,其他维度≥0。
FLOAT、FLOAT16、BFLOAT16、HIFLOAT8、FLOAT8_E4M3FN NCL、NCHW、NCDHW 3-5 √ cubeMathType(int8_t) 输入 用于判断Cube单元应该使用哪种计算逻辑进行运算。 - 如果输入的数据类型存在互推导关系,该参数默认对互推导后的数据类型进行处理。
- 支持的枚举值如下:
- 0(KEEP_DTYPE):保持输入数据类型进行计算。
- 1(ALLOW_FP32_DOWN_PRECISION):允许FLOAT降低精度计算,提升性能。
- 2(USE_FP16):使用FLOAT16精度进行计算。
- 3(USE_HF32):使用HFLOAT32(混合精度)进行计算。
INT8 - - - workspaceSize(uint64_t*) 输出 返回需要在Device侧申请的workspace大小。 - - - - - executor(aclOpExecutor**) 输出 返回op执行器,包含算子计算流程。 - - - - - -
返回值
aclnnStatus:返回状态码,具体参见aclnn返回码。
第一段接口完成入参校验,出现以下场景时报错:
返回值 错误码 描述 ACLNN_ERR_PARAM_NULLPTR 161001 传入的指针类型入参是空指针。 ACLNN_ERR_PARAM_INVALID 161002 input、weight、bias、output数据类型和数据格式不在支持的范围之内。 input和output数据类型不一致;transposed=false时,支持input和output数据类型不一致,不会触发该类型报错。 stride、padding、dilation、outputPadding输入shape不对。 groups输入不对的情况。 output的shape不满足infershape结果。 outputPadding值不满足要求。 input、weight、bias、output传入的空Tensor中部分维度为零的不满足要求。 input空间尺度在padding操作后小于weight(经过dilation扩张(如存在dilation>1的情况))的空间尺度(非transpose模式下)。 transpose模式下bias的shape不为1。 stride、dilation小于0情况下不满足要求。 当前处理器不支持卷积。 ACLNN_ERR_INNER_NULLPTR 561103 API内部校验错误,通常由于输入数据或属性的规格不在支持的范围之内导致。 ACLNN_ERR_RUNTIME_ERROR 361001 API调用npu runtime的接口异常,如SocVersion不支持。
aclnnConvolution
-
参数说明
参数名 输入/输出 描述 workspace 输入 在Device侧申请的workspace内存地址。 workspaceSize 输入 在Device侧申请的workspace大小,由第一段接口aclnnConvolutionGetWorkspaceSize获取。 executor 输入 op执行器,包含了算子计算流程。 stream 输入 指定执行任务的Stream。 -
返回值
aclnnStatus:返回状态码,具体参见aclnn返回码。
约束说明
- 确定性计算
- aclnnConvolution默认确定性实现。
| 约束类型 | Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品 | Atlas 200I/500 A2 推理产品 | Atlas 推理系列产品 | Ascend 950PR/Ascend 950DT |
|---|---|---|---|---|
| input、weight |
|
input、weight数据类型不支持HIFLOAT8、FLOAT8_E4M3FN。 |
|
input、weight数据类型支持FLOAT、FLOAT16、BFLOAT16、HIFLOAT8。
|
| bias |
|
|
bias数据类型不支持BFLOAT16、HIFLOAT8、FLOAT8_E4M3FN。Conv3D正向场景仅支持FLOAT16。 |
bias数据类型不支持HIFLOAT8、FLOAT8_E4M3FN。
|
| stride | conv3d transposed=true场景,strideD应该大于等于1,strideH、strideW应该在[1,63]的范围内。conv1d和conv2d transposed=true场景,各个值都应该大于等于1。conv3d正向场景,strideH和strideW应该在[1,63]的范围内。 | conv3d transposed=true场景,strideD、strideH、strideW应该大于等于1。conv3d transposed=false场景,strideH、strideW应该在[1,63]的范围内,strideD应该在[1, 1000000]的范围内。 | ||
| padding | conv3d transposed=true场景,paddingD应该大于等于0,paddingH、paddingW应该在[0,255]的范围内。conv1d和conv2d transposed=false场景,各个值都应该在[0,255]的范围内。conv3d正向场景,paddingH和paddingW应该在[0,255]的范围内。 | conv3d transposed=true场景,paddingD、paddingH、paddingW应该大于等于0。conv3d transposed=false场景,paddingH、paddingW应该在[0,255]范围内,paddingD应该在[0, 1000000]的范围内。 | ||
| dilation | conv1d、conv2d和conv3d transposed=true场景,各个值都应该在[1,255]的范围内。conv3d正向场景,dilationH和dilationW应该在[1,255]的范围内。 | conv3d transposed=true场景,dilationD、dilationH、dilationW应该大于等于1。conv3d transposed=false场景,dilationH、dilationW应该在[1,255]范围内,dilationD应该在[1, 1000000]的范围内。 | ||
| cubeMathType |
|
|
|
|
| 其他约束 | input, weight, bias中每一组tensor的每一维大小都应不大于1000000。 |
|
|
transposed为true的场景,支持1D、2D和3D卷积,支持空Tensor,此时padding区域梯度的计算行为取决于输入shape,根据算子优化策略的不同,padding区域梯度可能直接置0。 |
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#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) {
// 固定写法,资源初始化
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, 2, 2};
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 = {0, 0, 0, 0};
convOutPads = {0, 0, 0, 0};
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初始化,参考acl API手册
// 根据自己的实际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;
}