SoftmaxFlashV2样例

概述

本样例基于Kernel直调算子工程，介绍了调用SoftmaxFlashV2高阶api实现softmaxflashv2单算子，SoftmaxFlash增强版本，对应FlashAttention-2算法。

支持的产品

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

目录结构介绍

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

算子描述

• 算子功能：
  softmaxflashv2单算子，将输入tensor[m0, m1, ...mt, n]（t大于等于0）的非尾轴长度相乘的结果看作m，则输入tensor的shape看作[m, n]。对输入tensor[m, n]按行做如下计算，不同的update值对应不同的计算公式，其中x、inmax和insum为输入，M、S、E均为输出。 update为false：

  \begin{align*} M&=\text{rowmax}(x_i)\\ \text{SoftmaxFlashV2}(z_i)&=\exp(x_i - M)\\ S&=\sum_{i}^{n} \exp(x_i - M) \end{align*}

  update为true：

  \begin{align*} M&=\max(\text{rowmax}(x_i), \text{inmax})\\ \text{SoftmaxFlashV2}(z_i)&=\exp(x_i - M)\\ E&=\exp(\text{inmax}_i - M)\\ S&=\sum_{i}^{n} \exp(x_i - M)+E \cdot \text{insum} \end{align*}

• 算子规格：

算子类型(OpType)	SoftmaxflashCustom
算子输入
	name	shape	data type	format
	x	960*960	float	ND
算子输出
	max	960*8	float	ND
	sum	960*8	float	ND
核函数名	softmaxflashv2_custom

• 算子实现：
  本样例中实现的是固定shape为输入x [960, 960], 输出max[960, 8], sum[960, 8]的softmaxflashv2算子。

  • kernel实现

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

  softmaxflashv2算子的实现流程分为3个基本任务：CopyIn，Compute，CopyOut。CopyIn任务负责将Global Memory上的输入Tensor xGm搬运至Local Memory，存储在xLocal，Compute任务负责对xLocal执行softmaxflashv2计算，计算结果存储在maxLocal和sumLocal中，CopyOut任务负责将输出数据maxLocal和sumLocal搬运至Global Memory上的输出Tensor maxGm和sumGm中。

• tiling实现

  softmaxflashv2算子的tiling实现流程如下：首先对shape按照行数进行分核，使用平均分配法先按照核数向上对齐分配，确定主核的计算行数，再确定尾核计算行数，对主核计算的shape调用SoftmaxFlashV2高阶API的tiling函数获取API所需tiling参数，尾核计算所需的高阶API的tiling由kernel侧自行计算。

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

编译运行

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

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