CANN/ops-nn组归一化算子

aclnnGroupNorm【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nn 查看源码产品支持情况产品是否支持Ascend 950PR/Ascend 950DT√Atlas A3 训练系列产品/Atlas A3 推理系列产品√Atlas A2 训练系列产品/Atlas A2 推理系列产品√Atlas 200I/500 A2 推理产品×Atlas 推理系列产品√Atlas 训练系列产品√功能说明接口功能计算输入self的组归一化结果out均值meanOut标准差的倒数rstdOut。计算公式记 $xself$$E[x] \bar{x}$代表$x$的均值$Var[x] \frac{1}{n - 1} * \sum_{i1}^n(x_i - E[x])^2$代表$x$的样本方差则$$ out \frac{x - E[x]}{\sqrt{Var[x] eps}} * \gamma \beta $$$$ meanOut E[x] $$$$ rstdOut \frac{1}{\sqrt{Var[x] eps}} $$函数原型每个算子分为两段式接口必须先调用aclnnGroupNormGetWorkspaceSize接口获取计算所需workspace大小以及包含了算子计算流程的执行器再调用aclnnGroupNorm接口执行计算。aclnnStatus aclnnGroupNormGetWorkspaceSize( const aclTensor *self, const aclTensor *gamma, const aclTensor *beta, int64_t N, int64_t C, int64_t HxW, int64_t group, double eps, aclTensor *out, aclTensor *meanOut, aclTensor *rstdOut, uint64_t *workspaceSize, aclOpExecutor **executor)aclnnStatus aclnnGroupNorm( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)aclnnGroupNormGetWorkspaceSize参数说明参数名输入/输出描述使用说明数据类型数据格式维度(shape)非连续TensorselfaclTensor*输入表示进行归一化计算的输入对应公式中的x。支持空Tensor。FLOAT32、FLOAT16、BFLOAT16ND2-8√gammaaclTensor*输入表示进行归一化计算的缩放因子权重对应公式中的γ。支持空Tensor。数据类型与self相同。元素数量需与C相同。FLOAT32、FLOAT16、BFLOAT16ND1√betaaclTensor*输入表示进行归一化计算的偏移量对应公式中的β。支持空Tensor。数据类型与self相同。元素数量需与C相同。FLOAT32、FLOAT16、BFLOAT16ND1√Nint64_t输入表示输入self在N维度上的空间大小。-----Cint64_t输入表示输入self在C维度上的空间大小。-----HxWint64_t输入表示输入self在除N、C维度外的空间大小。若无其他维度则为1。----groupint64_t输入表示将输入self的C维度分为group组。group需大于0。----epsdouble输入out和rstdOut计算公式中的eps值为数值稳定性而加到分母上的值。需大于0若保持精度则eps需大于等于1e-5。----outaclTensor*输出表示进行归一化计算的结果对应公式中的out。支持空Tensor。数据类型和shape与self相同。数据格式和self相同。FLOAT32、FLOAT16、BFLOAT16ND2-8√meanOutaclTensor*输出表示进行归一化后的均值对应公式中的meanOut。支持空Tensor。数据类型与self相同。shape为(N, group)。FLOAT32、FLOAT16、BFLOAT16ND2√rstdOutaclTensor*输出表示进行归一化后标准差的倒数对应公式中的rstdOut。支持空Tensor。数据类型与self相同。shape为(N, group)。FLOAT32、FLOAT16、BFLOAT16ND2√workspaceSizeuint64_t*输出返回用户需要在Device侧申请的workspace大小。-----executoraclOpExecutor**输出返回op执行器包含了算子计算流程。-----Atlas 训练系列产品 、 Atlas 推理系列产品 参数self、gamma、beta、out、meanOut、rstdOut的数据类型不支持BFLOAT16。返回值aclnnStatus: 返回状态码具体参见aclnn返回码。第一段接口完成入参校验出现以下场景时报错返回码错误码描述ACLNN_ERR_PARAM_NULLPTR161001如果传入参数是必选输入输出或者必选属性且是空指针。ACLNN_ERR_PARAM_INVALID161002self、gamma、beta、out、meanOut、rstdOut数据类型不在支持的范围之内。gamma、beta、out、meanOut、rstdOut的数据类型与self不同。self的维度小于2维或者大于8维。group不大于0。C不能被group整除。eps不大于0。out的shape与x不同。meanOut与rstdOut的shape不为(N, group)。self在N维度上的空间大小不等于N。self在C维度上的空间大小不等于C。self第三维度及之后维度的size乘积不等于HxW(self为二维时HxW需要为1)。self的元素数量不等于N*C*HxW。gamma不为1维且元素数量不等于C。beta不为1维且元素数量不等于C。self和out的格式不同时。aclnnGroupNorm参数说明参数名输入/输出描述workspace输入在Device侧申请的workspace内存地址。workspaceSize输入在Device侧申请的workspace大小由第一段接口aclnnGroupNormGetWorkspaceSize获取。executor输入op执行器包含了算子计算流程。stream输入指定执行任务的Stream。返回值aclnnStatus返回状态码具体参见aclnn返回码。约束说明确定性计算aclnnGroupNorm默认确定性实现。调用示例示例代码如下仅供参考具体编译和执行过程请参考编译与运行样例。#include iostream #include vector #include acl/acl.h #include aclnnop/aclnn_group_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::vectorint64_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::vectorT hostData, const std::vectorint64_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::vectorint64_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初始化参考acl API手册 // 根据自己的实际device填写deviceId int32_t deviceId 0; aclrtStream stream; auto ret Init(deviceId, stream); // check根据自己的需要处理 CHECK_RET(ret 0, LOG_PRINT(Init acl failed. ERROR: %d\n, ret); return ret); // 2. 构造输入与输出需要根据API的接口自定义构造 std::vectorint64_t selfShape {2, 3, 4}; std::vectorint64_t gammaShape {3}; std::vectorint64_t betaShape {3}; std::vectorint64_t outShape {2, 3, 4}; std::vectorint64_t meanOutShape {2, 1}; std::vectorint64_t rstdOutShape {2, 1}; void* selfDeviceAddr nullptr; void* gammaDeviceAddr nullptr; void* betaDeviceAddr nullptr; void* outDeviceAddr nullptr; void* meanOutDeviceAddr nullptr; void* rstdOutDeviceAddr nullptr; aclTensor* self nullptr; aclTensor* gamma nullptr; aclTensor* beta nullptr; aclTensor* out nullptr; aclTensor* meanOut nullptr; aclTensor* rstdOut nullptr; std::vectorfloat selfHostData {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0, 23.0, 24.0}; std::vectorfloat gammaHostData {2.0, 2, 2}; std::vectorfloat betaHostData {2.0, 2, 2}; std::vectorfloat outHostData {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0, 23.0, 24.0}; std::vectorfloat meanOutHostData {2.0, 2}; std::vectorfloat rstdOutHostData {2.0, 2}; int64_t N 2; int64_t C 3; int64_t HxW 4; int64_t group 1; double eps 1e-5; // 创建self aclTensor ret CreateAclTensor(selfHostData, selfShape, selfDeviceAddr, aclDataType::ACL_FLOAT, self); CHECK_RET(ret ACL_SUCCESS, return ret); // 创建gamma aclTensor ret CreateAclTensor(gammaHostData, gammaShape, gammaDeviceAddr, aclDataType::ACL_FLOAT, gamma); CHECK_RET(ret ACL_SUCCESS, return ret); // 创建beta aclTensor ret CreateAclTensor(betaHostData, betaShape, betaDeviceAddr, aclDataType::ACL_FLOAT, beta); 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); // 创建meanOut aclTensor ret CreateAclTensor(meanOutHostData, meanOutShape, meanOutDeviceAddr, aclDataType::ACL_FLOAT, meanOut); CHECK_RET(ret ACL_SUCCESS, return ret); // 创建rstdOut aclTensor ret CreateAclTensor(rstdOutHostData, rstdOutShape, rstdOutDeviceAddr, aclDataType::ACL_FLOAT, rstdOut); CHECK_RET(ret ACL_SUCCESS, return ret); // 3. 调用CANN算子库API需要修改为具体的API uint64_t workspaceSize 0; aclOpExecutor* executor; // 调用aclnnGroupNorm第一段接口 ret aclnnGroupNormGetWorkspaceSize( self, gamma, beta, N, C, HxW, group, eps, out, meanOut, rstdOut, workspaceSize, executor); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclnnGroupNormGetWorkspaceSize 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;); } // 调用aclnnGroupNorm第二段接口 ret aclnnGroupNorm(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclnnGroupNorm 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::vectorfloat outResultData(size, 0); ret aclrtMemcpy( outResultData.data(), outResultData.size() * sizeof(outResultData[0]), outDeviceAddr, size * sizeof(float), 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(outResultData[%ld] is: %f\n, i, outResultData[i]); } size GetShapeSize(meanOutShape); std::vectorfloat meanResultData(size, 0); ret aclrtMemcpy( meanResultData.data(), meanResultData.size() * sizeof(meanResultData[0]), meanOutDeviceAddr, size * sizeof(float), 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(meanResultData[%ld] is: %f\n, i, meanResultData[i]); } size GetShapeSize(rstdOutShape); std::vectorfloat rstdResultData(size, 0); ret aclrtMemcpy( rstdResultData.data(), rstdResultData.size() * sizeof(rstdResultData[0]), rstdOutDeviceAddr, size * sizeof(float), 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(rstdResultData[%ld] is: %f\n, i, rstdResultData[i]); } // 6. 释放aclTensor和aclScalar需要根据具体API的接口定义修改 aclDestroyTensor(self); aclDestroyTensor(gamma); aclDestroyTensor(beta); aclDestroyTensor(out); aclDestroyTensor(meanOut); aclDestroyTensor(rstdOut); // 7. 释放device资源需要根据具体API的接口定义修改 aclrtFree(selfDeviceAddr); aclrtFree(gammaDeviceAddr); aclrtFree(betaDeviceAddr); aclrtFree(outDeviceAddr); aclrtFree(meanOutDeviceAddr); aclrtFree(rstdOutDeviceAddr); if (workspaceSize 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; }【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nn创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考