使用TmpBuf实现VectorAdd算子样例

概述

本样例展示了一个支持bfloat16_t数据类型的向量加法（Add）算子，并重点演示了在算子计算过程中使用临时缓冲区（TmpBuf）进行数据转换的典型方法。

支持的产品

• Atlas A3 训练系列产品/Atlas A3 推理系列产品
• Atlas A2 训练系列产品/Atlas A2 推理系列产品

目录结构介绍

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

算子描述

• 算子功能：
  Add算子实现了两个数据相加，返回相加结果的功能。对应的数学表达式为：

  z = x + y
  

• 算子规格：

  算子类型(OpType)	Add
  算子输入	name	shape	data type	format
  	x	1 * 2048	bfloat16_t	ND
  	y	1 * 2048	bfloat16_t	ND
  算子输出	z	1 * 2048	bfloat16_t	ND
  核函数名	add_custom

• 算子实现：
  计算逻辑是：Ascend C提供的矢量计算接口的操作元素都为LocalTensor，输入数据需要先搬运进片上存储，然后使用Cast接口进行数据转换，并将结果存入临时内存中。之后再调用计算接口完成两个输入参数相加，得到最终结果，再搬出到外部存储上。

  Add算子的实现流程分为3个基本任务：CopyIn，Compute，CopyOut。
  CopyIn任务负责将Global Memory上的输入Tensor xGm和yGm搬运到Local Memory，分别存储在xLocal、yLocal；
  Compute任务负责对xLocal、yLocal进行类型转换，并执行加法操作，计算结果存储在zLocal中；
  CopyOut任务负责将输出数据从zLocal搬运至Global Memory上的输出Tensor zGm中。

  • 调用实现
    使用内核调用符<<<>>>调用核函数。

编译运行

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

• 配置环境变量
  请根据当前环境上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                        # 执行编译生成的可执行程序，执行样例
  python3 ../scripts/verify_result.py output/output.bin output/golden.bin   # 验证输出结果是否正确，确认算法逻辑正确
  

  执行结果如下，说明精度对比成功。

  test pass!