README.md

兼容Scatter算子直调样例

概述

本样例介绍兼容Scatter算子实现及核函数直调方法,不支持Scatter能力的AI处理器,可以使用标量搬出的方式进行算子层面的仿真处理和修改算法的方式改变当前使用Scatter指令的算法。本样例是通过标量搬出的方式,使用<<<>>>内核调用符来完成算子核函数在NPU侧运行验证的基础流程,给出了对应的端到端实现。

支持的产品

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

目录结构介绍

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

算子描述

  • 算子功能:
    Scatter功能:给定一个连续的输入张量和一个目的地址偏移张量,Scatter指令根据偏移地址生成新的结果张量后将输入张量分散到结果张量中。

  • 算子规格:

    算子类型(OpType)Scatter
    算子输入nameshapedata typeformatdefault
    x-float16ND\
    y-uint32ND\
    算子输出out-float16ND\
    attr属性value\float16\1.0
    核函数名scatter_custom
  • 算子实现:
    样例中实现的是使用标量搬出的方式对于Scatter功能变换的兼容。

    • Scatter兼容策略

      • 标量搬出方式兼容Scatter: 对于完全离散的场景,只能通过标量搬出的方式进行处理。

      • 修改算法的方式兼容Scatter: 对于部分有规律的离散计算,譬如[0~63][128~191][256~319]...这种数据可以通过Loop循环搬出的方式来提升效率。

        64 32 64 16 64 32 64

        搬运非连续多个64长度的值出去时(存在部分规律),可以通过Loop循环使能方式进行数据搬运。

    • kernel实现
      兼容Scatter算子的实现流程分为3个基本任务:CopyIn任务负责将Global Memory上的输入Tensor srcGm和dstGm搬运到Local Memory,分别存储在xLocal、yLocal,Compute任务负责对xLocal、yLocal进行标量计算,计算结果存储在zLocal中,CopyOut任务负责将输出数据从zLocal搬运至Global Memory上的输出Tensor dstGm中。

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

编译运行

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

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