README.md

SoftmaxFlashV2样例

概述

本样例在大语言模型注意力机制场景下,基于SoftmaxFlashV2高阶API实现softmaxflashv2单算子。该API是SoftmaxFlash增强版本,对应FlashAttention-2算法,支持update模式(增量计算),常用于大语言模型中的注意力机制计算和长序列分块处理场景。本样例使用float数据类型,输入Tensor shape为[960, 960],完成SoftmaxFlashV2注意力计算。

本样例支持的产品及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

目录结构介绍

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

样例描述

  • 样例功能: 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:

    M=rowmax(xi)M = rowmax(x_i)

    SoftmaxFlashV2(zi)=exp(xi−M)SoftmaxFlashV2(z_i) = exp(x_i - M)

    S=∑inexp⁡(xi−M)S=\sum_{i}^{n} \exp(x_i - M)

    update为true:

    M=max(rowmax(xi),inmax)M = max(rowmax(x_i), inmax)

    SoftmaxFlashV2(zi)=exp(xi−M)SoftmaxFlashV2(z_i) = exp(x_i - M)

    E=exp(inmaxi−M)E = exp(inmax_i - M)

    S=suminexp(xi−M)+E⋅insumS = sum_{i}^{n} exp(x_i - M) + E \cdot insum

  • 样例规格:

表1:样例规格表
样例类型(OpType)Softmaxflash
样例输入
nameshapedata typeformat
x [960, 960] floatND
样例输出
max [960, 8] floatND
sum [960, 8] floatND
核函数名softmaxflashv2_custom
  • 样例实现:
    本样例中实现的是固定shape为输入x [960, 960],输出max[960, 8]、sum[960, 8]的softmaxflashv2样例。

    • Kernel实现
      核心计算步骤:将输入数据搬入后,调用 AscendC::SoftmaxFlashV2(xLocal, sumLocal, maxLocal, xLocal, expmaxLocal, sharedTmpBuffer, softmaxTiling) 完成 SoftmaxFlashV2 计算,再将结果搬出。

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

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

编译运行

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

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

    source ${install_path}/cann/set_env.sh
    

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

  • 样例执行

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

    mkdir -p build && cd 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(默认)、cpusim 运行模式: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!