cann-robotlibraries && best_practices sample

Erf样例

概述

本样例演示了基于Erf高阶API的算子实现。样例按元素做误差函数计算（也称为高斯误差函数，error function or Gauss error function）。

支持的产品

Ascend 950PR/Ascend 950DT
Atlas A3 训练系列产品/Atlas A3 推理系列产品
Atlas A2 训练系列产品/Atlas A2 推理系列产品

目录结构介绍

├── erf
│   ├── scripts
│   │   ├── gen_data.py         // 输入数据和真值数据生成脚本
│   ├── CMakeLists.txt          // 编译工程文件
│   ├── data_utils.h            // 数据读入写出函数
│   └── erf.asc      // Ascend C算子实现 & 调用样例

算子描述

算子功能：
按元素做误差函数计算（也称为高斯误差函数，error function or Gauss error function）。
$Erf(x)=2π∫x0e−t2dt\mathrm{Erf}(x) = \frac{2}{\sqrt{\pi}} \int_x^0 e^{-t^2} dt$
算子规格：

算子类型(OpType) erf

算子输入

name shape data type format

x 1*12288 float ND

算子输出

y 1*12288 float ND

核函数名 erf_custom
算子实现：
本样例中实现的是固定shape为输入x[1, 12288]，输出y[1, 12288]的erf_custom算子。
- Kernel实现
  
  计算逻辑是：Ascend C提供的矢量计算接口的操作元素都为LocalTensor，输入数据需要先搬运进片上存储，然后使用Erf高阶API接口完成Erf计算，得到最终结果，再搬出到外部存储上。
  
  erf_custom算子的实现流程分为3个基本任务：CopyIn，Compute，CopyOut。CopyIn任务负责将Global Memory上的输入Tensor xGm存储在xLocal中，Compute任务负责对xLocal执行Erf计算，计算结果存储在yLocal中，CopyOut任务负责将输出数据从yLocal搬运至Global Memory上的输出Tensor yGm。
- Tiling实现
  
  根据输入长度和所用核数量设置tiling参数totalLength和coreNum。
- 调用实现
  使用内核调用符<<<>>>调用核函数。

编译运行

在本样例根目录下执行如下步骤，编译并执行算子。

配置环境变量
请根据当前环境上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!

算子类型(OpType)	erf
算子输入
	name	shape	data type	format
	x	1*12288	float	ND
算子输出
算子输出	y	1*12288	float	ND
核函数名	erf_custom