aclnnBatchNormElemt
支持的产品型号
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
每个算子分为两段式接口,必须先调用“aclnnBatchNormElemtGetWorkspaceSize”接口获取入参并根据流程计算所需workspace大小,再调用“aclnnBatchNormElemt”接口执行计算。
aclnnStatus aclnnBatchNormElemtGetWorkspaceSize(const aclTensor* input, const aclTensor* weight, const aclTensor* bias, aclTensor* mean, aclTensor* invstd, double eps, aclTensor* output, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnBatchNormElemt(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
算子功能: 根据全局的均值和标准差倒数对输入数据做Batch Normalization,走推理模式。
计算公式:
标准差与方差的关系如下:
aclnnBatchNormElemtGetWorkspaceSize
参数说明:
- input(const aclTensor *, 计算输入): Device侧的aclTensor,数据类型仅支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续的Tensor,支持的shape和格式有:2维(对应的格式为NC),3维(对应的格式为NCL),4维(对应的格式为NCHW),5维(对应的格式为NCDHW),6-8维(对应的格式为ND,其中第2维固定为channel轴)。
- weight(const aclTensor *, 计算输入): bn权重,Device侧的aclTensor,数据类型支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续Tensor,数据格式为ND,shape为一维,长度和Input入参中C轴的长度相同。
- bias(const aclTensor *, 计算输入): bn偏置,Device侧的aclTensor,数据类型支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续Tensor,数据格式为ND,shape为一维,长度和Input入参中C轴的长度相同。
- mean(aclTensor *, 计算输入): 输入数据均值,Device侧的aclTensor,数据类型支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续Tensor,数据格式为ND,shape为一维,长度和Input入参中C轴的长度相同。
- invstd(aclTensor *, 计算输入): 输入数据标准差倒数,Device侧的aclTensor,数据类型支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续Tensor,数据格式为ND,shape为一维,长度和Input入参中C轴的长度相同。仅支持元素值均大于0的场景。
- eps(double, 计算输入): 用于防止产生除0的偏移,Host侧的double值,数据类型支持DOUBLE,默认值为1e-5。
- output(aclTensor *, 计算输出): Device侧的aclTensor,数据类型仅支持FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持),支持非连续的Tensor,支持的shape和格式有:2维(对应的格式为NC),3维(对应的格式为NCL),4维(对应的格式为NCHW),5维(对应的格式为NCDHW),6-8维(对应的格式为ND,其中第2维固定为channel轴)。
- workspaceSize(uint64_t *, 出参): 返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor **, 出参): 返回op执行器,包含了算子计算流程。
返回值:
aclnnStatus: 返回状态码,具体参见aclnn返回码。
第一段接口完成入参校验,出现以下场景时报错:
161001 (ACLNN_ERR_PARAM_NULLPTR):1. 传入的指针类型入参是空指针。
161002 (ACLNN_ERR_PARAM_INVALID):1. input,output数据类型和数据格式不在支持的范围之内。
2. input和output数据的shape不在支持的范围内。
3. mean/invstd/weightOptional/biasOptional 维度不为一维,并且shape不等于input C轴的长度。
aclnnBatchNormElemt
参数说明:
- workspace(void *, 入参): 在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参): 在Device侧申请的workspace大小,由第一段接口aclnnBatchNormElemtGetWorkspaceSize获取。
- executor(aclOpExecutor *, 入参): op执行器,包含了算子计算流程。
- stream(aclrtStream , 入参): 指定执行任务的AscendCL Stream流。
返回值:
aclnnStatus: 返回状态码,具体参见aclnn返回码。
约束与限制
无
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_batch_norm_elemt.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根据自己的需要处理
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. 构造输入与输出,需要根据API的接口自定义构造
std::vector<int64_t> inputShape = {2, 4, 2};
std::vector<int64_t> meanShape = {4};
std::vector<int64_t> invstdShape = {4};
std::vector<int64_t> outShape = {2, 4, 2};
double eps = 1e-2;
void* inputDeviceAddr = nullptr;
void* meanDeviceAddr = nullptr;
void* invstdDeviceAddr = nullptr;
void* outDeviceAddr = nullptr;
aclTensor* input = nullptr;
aclTensor* mean = nullptr;
aclTensor* invstd = nullptr;
aclTensor* out = nullptr;
std::vector<float> inputHostData = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};
std::vector<float> meanHostData = {1, 2, 3, 4};
std::vector<float> invstdHostData = {5, 6, 7, 8};
std::vector<float> outHostData(16, 0);
// 创建input aclTensor
ret = CreateAclTensor(inputHostData, inputShape, &inputDeviceAddr, aclDataType::ACL_FLOAT, &input);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建mean aclTensor
ret = CreateAclTensor(meanHostData, meanShape, &meanDeviceAddr, aclDataType::ACL_FLOAT, &mean);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建invstd aclTensor
ret = CreateAclTensor(invstdHostData, invstdShape, &invstdDeviceAddr, aclDataType::ACL_FLOAT, &invstd);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// aclnnBatchNormElemt接口调用示例
// 3. 调用CANN算子库API,需要修改为具体的API名称
// 调用aclnnBatchNormElemt第一段接口
ret = aclnnBatchNormElemtGetWorkspaceSize(input, nullptr, nullptr, mean, invstd, eps, out, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBatchNormElemtGetWorkspaceSize 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);
}
// 调用aclnnBatchNormElemt第二段接口
ret = aclnnBatchNormElemt(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBatchNormElemt 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]);
}
// 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
aclDestroyTensor(input);
aclDestroyTensor(mean);
aclDestroyTensor(invstd);
aclDestroyTensor(out);
// 7. 释放Device资源,需要根据具体API的接口定义修改
aclrtFree(inputDeviceAddr);
aclrtFree(meanDeviceAddr);
aclrtFree(invstdDeviceAddr);
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}