--- title: aclnnBatchNorm description: "[? 查看源码](https://gitcode.com/cann/ops-nn/tree/master/norm/batch_norm_v3)" url: https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/API/aolapi/context/ops-nn/aclnnBatchNorm.md sourcePath: /source/zh/CANNCommunityEdition/920beta1/API/aolapi/context/ops-nn/aclnnBatchNorm.md indexId: 6ca1d785e85f7c4f7972c4ffa60de619afd20fbc0632ee59b08aa0ae7ca46dfd84 --- # aclnnBatchNorm [? 查看源码](https://gitcode.com/cann/ops-nn/tree/master/norm/batch_norm_v3) ## 产品支持情况 - Ascend 950PR/Ascend 950DT：支持 - Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持 - Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持 - Atlas 200I/500 A2 推理产品：不支持 - Atlas 推理系列产品：支持 - Atlas 训练系列产品：支持 ## 功能说明 - 接口功能：对一个批次的数据做批量归一化处理，正则化之后生成的数据的统计结果为0均值、1标准差。 - 计算公式： $$ y = \frac{(x - E(x))}{\sqrt{Var(x) + eps}} * weight + bias $$ E(x)表示均值，Var(x)表示方差，均需要在算子内部计算得到；eps表示一个极小的浮点数，防止分母为0的情况。 ## 函数原型 每个算子分为两段式接口，必须先调用“aclnnBatchNormGetWorkspaceSize”接口获取入参并根据流程计算所需workspace大小，再调用“aclnnBatchNorm”接口执行计算。 ```Cpp aclnnStatus aclnnBatchNormGetWorkspaceSize( const aclTensor *input, const aclTensor *weight, const aclTensor *bias, aclTensor *runningMean, aclTensor *runningVar, bool training, double momentum, double eps, aclTensor *output, aclTensor *saveMean, aclTensor *saveInvstd, uint64_t *workspaceSize, aclOpExecutor **executor) ``` ```Cpp aclnnStatus aclnnBatchNorm( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream) ``` ## aclnnBatchNormGetWorkspaceSize - **参数说明** | 参数名 | 输入/输出 | 描述 | 使用说明 | 数据类型 | 数据格式 | 维度(shape) | 非连续Tensor | | --- | --- | --- | --- | --- | --- | --- | --- | | input（aclTensor*） | 输入 | 表示进行BatchNorm计算的输入，对应公式中的`x`。 | 支持空Tensor。 支持的shape和格式有：2维（对应的格式为NC），3维（对应的格式为NCL），4维（对应的格式为NCHW、NHWC），5维（对应的格式为NCDHW、NDHWC），6-8维（对应的格式为ND，其中第2维固定为channel轴）。 | FLOAT32、FLOAT16、BFLOAT16 | NC、NCL、NCHW、NHWC、NCDHW、NDHWC、ND | 2-8 | √ | | weight（aclTensor*） | 输入 | 表示进行BatchNorm计算的权重Tensor，对应公式中的`weight`。 | 支持空Tensor。 可选参数。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | bias（aclTensor*） | 输入 | 表示进行BatchNorm计算的偏置Tensor，对应公式中的`bias`。 | 支持空Tensor。 可选参数。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | runningMean（aclTensor*） | 输入 | 表示推理期间使用的平均值，对应公式中的`E(x)`。 | 支持空Tensor。 可选参数。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | runningVar（aclTensor*） | 输入 | 表示推理期间使用的方差，对应公式中的`Var(x)`。 | 支持空Tensor。 可选参数，数值为非负数。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | training（bool） | 输入 | 表示标记是否训练场景。 | true表示训练场景，false表示推理场景。 | - | - | - | - | | momentum（double） | 输入 | 表示用于更新运行均值和方差的动量系数。 | - | - | - | - | - | | eps（double） | 输入 | 表示添加到方差中的值，以避免出现除以零的情况。对应公式中的`eps`。 | - | - | - | - | - | | output（aclTensor*） | 输出 | 表示BatchNorm的输出结果，对应公式中的`y`。 | 支持空Tensor。 数据类型、数据格式和shape与入参`input`保持一致。 | FLOAT32、FLOAT16、BFLOAT16 | NC、NCL、NCHW、NHWC、NCDHW、NDHWC、ND | 2-8 | √ | | saveMean（aclTensor*） | 输出 | 只在训练场景输出，表示保存的均值，对应公式中的`E(x)`。 | 支持空Tensor。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | saveInvstd（aclTensor*） | 输出 | 只在训练场景输出，表示保存的input方差或者input标准差倒数，分别对应公式中的`Var(x)`、(Var(x) + eps)开平方的倒数。 | 支持空Tensor。 shape长度与入参`input`中channel轴的长度相等。 | FLOAT32、FLOAT16、BFLOAT16 | ND | 1 | √ | | workspaceSize（uint64_t*） | 输出 | 返回用户需要在Device侧申请的workspace大小。 | - | - | - | - | - | | executor（aclOpExecutor**） | 输出 | 返回op执行器，包含了算子计算流程。 | - | - | - | - | - | - Atlas 训练系列产品、Atlas 推理系列产品： - 参数`input`、`weight`、`bias`、`runningMean`、`runningVar`、`output`、`saveMean`、`saveInvstd`的数据类型不支持BFLOAT16。 - 参数`input`、`output`的数据格式不支持NHWC、NDHWC。 - 参数`saveInvstd`表示input的方差。 - Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品： - 参数`input`、`output`的数据格式不支持NHWC、NDHWC。 - 参数`saveInvstd`表示input的方差。 - Ascend 950PR/Ascend 950DT：参数`saveInvstd`表示input标准差的倒数。 - **返回值** aclnnStatus：返回状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现以下场景时报错： | 返回码 | 错误码 | 描述 | | --- | --- | --- | | ACLNN_ERR_PARAM_NULLPTR | 161001 | 传入的指针类型入参是空指针。 | | ACLNN_ERR_PARAM_INVALID | 161002 | 输入或输出Tensor的数据类型和数据格式不在支持的范围之内。 | | 输入或输出Tensor的shape不在支持的范围内。 | - | - | | weight，bias，runningMean，runningVar、saveMean（训练场景下）、saveInvstd（训练场景下）的shape长度与input shape中channel轴的长度不相等。 | - | - | | input和output的数据格式不一致。 | - | - | | input和output的shape不一致，或者shape的维度大于8维或者小于2维。 | - | - | ## aclnnBatchNorm - **参数说明** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | workspace | 输入 | 在Device侧申请的workspace内存地址。 | | workspaceSize | 输入 | 在Device侧申请的workspace大小，由第一段接口aclnnBatchNormGetWorkspaceSize获取。 | | executor | 输入 | op执行器，包含了算子计算流程。 | | stream | 输入 | 指定执行任务的Stream。 | - **返回值** aclnnStatus：返回状态码，具体参见aclnn返回码。 ## 约束说明 - 确定性计算： - aclnnBatchNorm默认非确定性实现，支持通过aclrtCtxSetSysParamOpt开启确定性。 ## 调用示例 示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。 ```Cpp #include #include #include "acl/acl.h" #include "aclnnop/aclnn_batch_norm.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& shape) { int64_t shapeSize = 1; for (auto i : shape) { shapeSize *= i; } return shapeSize; } 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 int CreateAclTensor( const std::vector& hostData, const std::vector& 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 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初始化，参考acl API手册 // 根据自己的实际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 selfShape = {1, 2, 4}; std::vector weightShape = {2}; std::vector biasShape = {2}; std::vector rMeanShape = {2}; std::vector rVarShape = {2}; std::vector outShape = {1, 2, 4}; std::vector meanShape = {2}; std::vector varShape = {2}; void* selfDeviceAddr = nullptr; void* weightDeviceAddr = nullptr; void* biasDeviceAddr = nullptr; void* rMeanDeviceAddr = nullptr; void* rVarDeviceAddr = nullptr; void* outDeviceAddr = nullptr; void* meanDeviceAddr = nullptr; void* varDeviceAddr = nullptr; aclTensor* self = nullptr; aclTensor* weight = nullptr; aclTensor* bias = nullptr; aclTensor* rMean = nullptr; aclTensor* rVar = nullptr; aclTensor* out = nullptr; aclTensor* mean = nullptr; aclTensor* var = nullptr; std::vector selfHostData = {0, 1, 2, 3, 4, 5, 6, 7}; std::vector weightHostData = {1, 1}; std::vector biasHostData = {0, 0}; std::vector rMeanHostData = {0, 0}; std::vector rVarHostData = {1, 1}; std::vector outHostData(8, 0); std::vector meanHostData = {1, 1}; std::vector varHostData = {1, 1}; bool training = true; double momentum = 0.1; double eps = 1e-5; // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建weight aclTensor ret = CreateAclTensor(weightHostData, weightShape, &weightDeviceAddr, aclDataType::ACL_FLOAT, &weight); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建bias aclTensor ret = CreateAclTensor(biasHostData, biasShape, &biasDeviceAddr, aclDataType::ACL_FLOAT, &bias); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建rMean aclTensor ret = CreateAclTensor(rMeanHostData, rMeanShape, &rMeanDeviceAddr, aclDataType::ACL_FLOAT, &rMean); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建rVar aclTensor ret = CreateAclTensor(rVarHostData, rVarShape, &rVarDeviceAddr, aclDataType::ACL_FLOAT, &rVar); 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); // 创建mean aclTensor ret = CreateAclTensor(meanHostData, meanShape, &meanDeviceAddr, aclDataType::ACL_FLOAT, &mean); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建var aclTensor ret = CreateAclTensor(varHostData, varShape, &varDeviceAddr, aclDataType::ACL_FLOAT, &var); CHECK_RET(ret == ACL_SUCCESS, return ret); uint64_t workspaceSize = 0; aclOpExecutor* executor; // aclnnBatchNorm接口调用示例 // 3. 调用CANN算子库API，需要修改为具体的API名称 // 调用aclnnBatchNorm第一段接口 ret = aclnnBatchNormGetWorkspaceSize( self, weight, bias, rMean, rVar, training, momentum, eps, out, mean, var, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBatchNormGetWorkspaceSize 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); } // 调用aclnnBatchNorm第二段接口 ret = aclnnBatchNorm(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBatchNorm 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 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(self); aclDestroyTensor(weight); aclDestroyTensor(bias); aclDestroyTensor(rMean); aclDestroyTensor(rVar); aclDestroyTensor(out); aclDestroyTensor(mean); aclDestroyTensor(var); // 7. 释放device资源，需要根据具体API的接口定义修改 aclrtFree(selfDeviceAddr); aclrtFree(weightDeviceAddr); aclrtFree(biasDeviceAddr); aclrtFree(rMeanDeviceAddr); aclrtFree(rVarDeviceAddr); aclrtFree(outDeviceAddr); aclrtFree(meanDeviceAddr); aclrtFree(varDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```