aclnnConvTbc
支持的产品型号
- Atlas 推理系列产品。
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
每个算子分为两段式接口，必须先调用“aclnnConvTbcGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnConvTbc”接口执行计算。
aclnnStatus aclnnConvTbcGetWorkspaceSize(const aclTensor *self, const aclTensor *weight,const aclTensor *bias, const int64_t pad, aclTensor *output, int8_t cubeMathType, uint64_t *workspaceSize, aclOpExecutor **executor)aclnnStatus aclnnConvTbc(void* workspace, const uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
- 算子功能：实现输入输出维度为 T(时间或空间维度)、B(批次)、C(通道)的一维卷积。
- 计算公式： 假定输入（input）的shape是()，输出（output）的shape是()，那输出将被表示为： 其中表示batch_size（批次），表示通道数，代表时间或空间维度。
aclnnConvTbcGetWorkspaceSize
参数说明：
- self（aclTensor*, 计算输入)：计算公式中的
input，数据格式，类型与weight一致，支持非连续的Tensor，shape为()，数据格式为NCL。- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT，FLOAT16，BFLOAT16。
- Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
- weight（aclTensor*, 计算输入)：计算公式中的
weight，数据格式，类型与self一致，支持非连续的Tensor，shape为()，数据格式为NCL。- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT，FLOAT16，BFLOAT16。
- Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
- bias（aclTensor*, 计算输入)：计算公式中的
bias，数据格式，支持非连续的Tensor，shape为()，数据格式为ND；bias传入的指针类型入参不允许是空指针。- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT，FLOAT16，BFLOAT16。
- Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
- pad(int64, 计算输入)：表示 H维度上左右的填充个数。
- output（aclTensor*, 计算输出)：计算公式中的
out，数据格式，类型与self一致，支持非连续的Tensor，shape为()，数据格式为NCL。- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT，FLOAT16，BFLOAT16。
- Atlas 推理系列产品、Atlas 训练系列产品：数据类型支持FLOAT，FLOAT16。
- 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推理产品：当输入是FLOAT，允许转换为HFLOAT32计算。当输入是BFLOAT16，仍使用BFLOAT16计算。
- 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计算。
- 0:KEEP_DTYPE，保持输入的数据类型进行计算。
- workspaceSize(uint64_t *，出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor **，出参)：返回op执行器，包含了算子计算流程。
- self（aclTensor*, 计算输入)：计算公式中的
返回值：
aclnnStatus：返回状态码，具体参见aclnn返回码。
161001 ACLNN_ERR_PARAM_NULLPTR: 1. 传入的指针类型入参是空指针。 161002 ACLNN_ERR_PARAM_INVALID: 1. self，weight，bias，output的数据类型和格式不在支持的范围内。 2. self，weight，output数据类型不一致。 3. output的shape不满足infershape结果。 4. output的shape中存在小于0的情况。 5. self的dim不为3。 6. weight的dim不为3。 7. bias的dim不为1。 8. self的第三个维度值不等于weight的第二个维度值。 9. bias的值不等于weight的第三个维度。
aclnnConvTbc
参数说明：
- workspace(void *, 入参)：在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnConvTbcGetWorkspaceSize获取。
- executor(aclOpExecutor *, 入参)：op执行器，包含了算子计算流程。
- stream(aclrtStream, 入参)：指定执行任务的AscendCL Stream流。
返回值： aclnnStatus：返回状态码，具体参见aclnn返回码。
约束与限制
无
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#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_NCL,
shape.data(), shape.size(), *deviceAddr);
return 0;
}
void Finalize(int32_t deviceId, aclrtStream& stream)
{
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
}
int aclnnConvTbcTest(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, 3};
std::vector<int64_t> shapeWeight = {3, 3, 4};
std::vector<int64_t> shapeBias = {4};
std::vector<int64_t> shapeResult = {2, 2, 4};
void* deviceDataA = nullptr;
void* deviceDataB = nullptr;
void* deviceDataC = nullptr;
void* deviceDataResult = nullptr;
aclTensor* input = nullptr;
aclTensor* weight = nullptr;
aclTensor* bias = nullptr;
aclTensor* result = nullptr;
std::vector<float> inputData(GetShapeSize(shapeInput), 1);
std::vector<float> weightData(GetShapeSize(shapeWeight), 1);
std::vector<float> biasData(GetShapeSize(shapeBias), 1);
std::vector<float> outputData(GetShapeSize(shapeResult), 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);
// 创建weigth 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);
// 创建bias aclTensor
ret = CreateAclTensor(biasData, shapeBias, &deviceDataC, aclDataType::ACL_FLOAT, &bias);
std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor *)> biasTensorPtr(bias, aclDestroyTensor);
std::unique_ptr<void, aclError (*)(void *)> deviceDataCPtr(deviceDataC, aclrtFree);
CHECK_FREE_RET(ret == ACL_SUCCESS, return ret);
// 创建result 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);
// 3. 调用CANN算子库API，需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnConvTbc第一段接口
ret = aclnnConvTbcGetWorkspaceSize(input, weight, bias, 1, result, 1, &workspaceSize, &executor);
CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnConvTbcGetWorkspaceSize 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);
}
// 调用aclnnConvTbc第二段接口
ret = aclnnConvTbc(workspaceAddr, workspaceSize, executor, stream);
CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnConvTbc 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 = aclnnConvTbcTest(deviceId, stream);
CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnConvTbcTest failed. ERROR: %d\n", ret); return ret);
Finalize(deviceId, stream);
return 0;
}