RmsNorm样例
概述
本样例基于Kernel直调算子工程，介绍了调用RmsNorm高阶API实现rmsnorm单算子，实现对shape大小为[B，S，H]的输入数据的RmsNorm归一化。
支持的产品
- Ascend 950PR/Ascend 950DT
- Atlas A3 训练系列产品/Atlas A3 推理系列产品
- Atlas A2 训练系列产品/Atlas A2 推理系列产品
目录结构介绍
├── rmsnorm
│ ├── scripts
│ │ ├── gen_data.py // 输入数据和真值数据生成脚本
│ ├── CMakeLists.txt // 编译工程文件
│ ├── data_utils.h // 数据读入写出函数
│ └── rmsnorm.asc // Ascend C算子实现 & 调用样例
算子描述
-
算子功能：
实现对shape大小为[B，S，H]的输入数据的RmsNorm归一化，其计算公式如下：yi=RmsNorm(xi)yi=xi1N∑i=1Nxi2+ε×γy_i = RmsNorm(x_i)\\ y_i=\frac{x_i}{\sqrt{\frac{1}{N}\sum_{i = 1}^{N}x_i^2+\varepsilon}}\times\gamma
-
算子规格：
算子类型(OpType) rmsnorm 算子输入 name shape data type format layernormv2 1 * 1 * 16 float ND gamma 16 float ND 算子输出 outdstput 1 * 1 * 16 float ND 核函数名 rmsnorm_custom -
算子实现：
本样例中实现的是固定shape(layernormv2[1, 1, 16], gamma[16], dst[1, 1, 16])的rmsnorm算子。-
kernel实现
计算逻辑是：Ascend C提供的矢量计算接口的操作元素都为LocalTensor，输入数据需要先搬运进片上存储，然后使用RmsNorm高阶API接口完成rmsnorm计算，得到最终结果，再搬出到外部存储上。
rmsnorm算子的实现流程分为3个基本任务：CopyIn，Compute，CopyOut。CopyIn任务负责将Global Memory上的输入Tensor inputX_gm、gamma_gm搬运至LocalMemory，分别存储在srcLocal、gammaLocal中，Compute任务负责对srcLocal、gammaLocal执行rmsnorm计算，计算结果存储在dstLocal中，CopyOut任务负责将输出数据从dstLocal搬运至Global Memory上的输出Tensor dstGm中。
-
tiling实现
rmsnorm算子的tiling实现流程如下：首先获取RmsNorm接口能完成计算所需最大/最小临时空间大小，根据该范围结合实际的内存使用情况设置合适的空间大小，然后根据输入shape、剩余的可供计算的空间大小等信息获取RmsNorm kernel侧接口所需tiling参数。
-
调用实现
使用内核调用符<<<>>>调用核函数。
-
编译运行
在本样例根目录下执行如下步骤，编译并执行算子。
-
配置环境变量
请根据当前环境上CANN开发套件包的安装方式，选择对应配置环境变量的命令。-
默认路径，root用户安装CANN软件包
source /usr/local/Ascend/cann/set_env.sh -
默认路径，非root用户安装CANN软件包
source $HOME/Ascend/cann/set_env.sh -
指定路径install_path，安装CANN软件包
source ${install_path}/cann/set_env.sh
-
-
样例执行
mkdir -p build && cd build; # 创建并进入build目录 cmake ..;make -j; # 编译工程 python3 ../scripts/gen_data.py # 生成测试输入数据 ./demo # 执行编译生成的可执行程序，执行样例执行结果如下，说明精度对比成功。
test pass!