Fmod样例

概述

本样例基于Fmod高阶API实现按元素浮点数取余的功能。

本样例支持的产品及CANN软件版本

产品	CANN软件版本
Ascend 950PR/Ascend 950DT	>= CANN 9.1.0
Atlas A3 训练系列产品/Atlas A3 推理系列产品	>= CANN 9.0.0
Atlas A2 训练系列产品/Atlas A2 推理系列产品	>= CANN 9.0.0

目录结构介绍

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

样例描述

• 样例功能：
  按元素计算两个浮点数a，b相除后的余数。

  计算公式如下：

  $$dstTenso{r}_i=Fmod(src0Tenso{r}_i,src1Tenso{r}_i)$$

  $$Fmod(x,y)=x-Trunc(x/y)\ast y$$

  其中，Trunc为向零取整操作。举例如下：

  Fmod(2.0, 1.5) = 0.5

  Fmod(-3.0, 1.1) = -0.8

• 样例规格：

  样例类型(OpType)	fmod
  样例输入
  	name	shape	data type	format
  	src0	[1, 159]	float	ND
  	src1	[1, 159]	float	ND
  样例输出
  	dst	[1, 159]	float	ND
  核函数名	fmod_custom

• 样例实现：
  本样例中实现的是固定shape为输入src0[1, 159]、src1[1, 159]，输出dst[1, 159]的fmod_custom样例。

  • Kernel实现

    使用Fmod高阶API计算取余运算，可选择使用临时buffer和指定计算元素个数

  • Tiling实现

    Host侧通过GetFmodMaxMinTmpSize获取Fmod接口计算所需的最大和最小临时空间。

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

编译运行

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

• 配置环境变量
  请根据当前环境上CANN开发套件包的安装方式，配置环境变量。

  source ${install_path}/cann/set_env.sh
  

  说明： ${install_path} 为CANN包安装目录，未指定安装目录时默认安装至 /usr/local/Ascend 下。

• 样例执行

  在本样例目录下执行如下命令。

  mkdir -p build && cd build;      # 创建并进入build目录
  cmake -DCMAKE_ASC_ARCHITECTURES=dav-2201 ..;make -j;    # 编译工程，默认npu模式
  python3 ../scripts/gen_data.py   # 生成测试输入数据
  ./demo                           # 执行编译生成的可执行程序，执行样例
  

  使用 CPU调试 或 NPU仿真 模式时，添加 -DCMAKE_ASC_RUN_MODE=cpu 或 -DCMAKE_ASC_RUN_MODE=sim 参数即可。

  示例如下：

  cmake -DCMAKE_ASC_RUN_MODE=cpu -DCMAKE_ASC_ARCHITECTURES=dav-2201 ..;make -j; # cpu调试模式
  cmake -DCMAKE_ASC_RUN_MODE=sim -DCMAKE_ASC_ARCHITECTURES=dav-2201 ..;make -j; # NPU仿真模式
  

  注意： 切换编译模式前需清理 cmake 缓存，可在 build 目录下执行 rm CMakeCache.txt 后重新 cmake。

• 编译选项说明

  选项	可选值	说明
  CMAKE_ASC_RUN_MODE	npu（默认）、cpu、sim	运行模式：NPU 运行、CPU调试、NPU仿真
  CMAKE_ASC_ARCHITECTURES	dav-2201（默认）、dav-3510	NPU 架构：dav-2201 对应 Atlas A2 训练系列产品/Atlas A2 推理系列产品和 Atlas A3 训练系列产品/Atlas A3 推理系列产品，dav-3510 对应 Ascend 950PR/Ascend 950DT

• 执行结果

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

  test pass!