Clamp样例

概述

本样例演示了基于Clamp高阶API的算子实现。样例将输入中除nan值以外大于max的数替换为max，小于min的数替换为min，小于等于max和大于等于min的数保持不变，作为输出。当min大于max时，将除nan值外所有值替换为max。min和max可以为标量或LocalTensor。

支持的产品

• Ascend 950PR/Ascend 950DT

目录结构介绍

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

算子描述

• 算子功能：
  将输入中除nan值以外大于max的数替换为max，小于min的数替换为min，小于等于max和大于等于min的数保持不变，作为输出。当min大于max时，将除nan值外所有值替换为max。min和max可以为标量或LocalTensor。

  计算公式如下：

  $$ds{t}_i=Clamp(sr{c}_i,mi{n}_i,ma{x}_i)$$

  $$ds{t}_i=\{\begin{array}{ll}mi{n}_i,& sr{c}_i<mi{n}_i\\ sr{c}_i,& mi{n}_i\le sr{c}_i,\le ma{x}_i\\ ma{x}_i,& sr{c}_i<ma{x}_i\end{array}$$

• 算子规格：

  算子类型(OpType)	clamp
  算子输入
  	name	shape	data type	format
  	src	128	float	ND
  	src_min	128	float	ND
  	src_max	128	float	ND
  算子输出
  	dst	128	float	ND
  核函数名	clamp_custom

• 算子实现：
  本样例中实现的是固定shape为输入src[128]、src_min[128]、src_max[128]，输出dst[128]的clamp_custom算子。

  • Kernel实现

    计算逻辑是：Ascend C提供的矢量计算接口的操作元素都为LocalTensor，输入数据需要先搬运进片上存储，然后使用Clamp高阶API接口完成Clamp计算，得到最终结果，再搬出到外部存储上。

    clamp_custom算子的实现流程分为3个基本任务：CopyIn，Compute，CopyOut。CopyIn任务负责将Global Memory上的输入Tensor srcGm、minGm、maxGm存储在srcLocal、minLocal、maxLocal中，Compute任务负责对srcLocal、minLocal、maxLocal执行Clamp计算，计算结果存储在dstLocal中，CopyOut任务负责将输出数据从dstLocal搬运至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                        # 执行编译生成的可执行程序，执行样例
  

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

  test pass!