README.md

MatmulLeakyRelu算子直调样例

概述

本样例基于Ascend C演示MatmulLeakyRelu算子的核函数直调实现。通过将矩阵乘加(Matmul)与LeakyRelu激活函数计算,实现计算步骤在硬件层面的高效协同执行,降低内存访问开销与计算延时。

支持的产品

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

目录结构介绍

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

算子描述

  • 算子功能:

    算子使用了MatmulLeakyRelu高阶API,实现了快速的MatmulLeakyRelu矩阵乘法的运算操作。
    MatmulLeakyRelu的计算公式为:

    C = A * B + Bias
    C = C > 0 ? C : C * 0.001
    
    • A、B为源操作数,A为左矩阵,形状为[M, K];B为右矩阵,形状为[K, N]。
    • C为目的操作数,存放矩阵乘结果的矩阵,形状为[M, N]。
    • Bias为矩阵乘偏置,形状为[N]。对A*B结果矩阵的每一行都采用该Bias进行偏置。
  • 算子规格:

    算子类型(OpType)MatmulLeakyRelu
    算子输入nameshapedata typeformat
    a1024 * 256float16ND
    b256 * 640float16ND
    bias640floatND
    算子输出c1024 * 640floatND
    核函数名matmul_leakyrelu_custom
  • 算子实现:

    本样例中实现的是[m, n, k]固定为[1024, 640, 256]的MatmulLeakyRelu算子。
    MatmulLeakyRelu算子的数学表达式为:

    C = A * B + Bias
    C = C > 0 ? C : C * 0.001
    

    其中A的形状为[1024, 256],B的形状为[256, 640],C的形状为[1024, 640],Bias的形状为[640]。

    • Kernel实现
      初始化Tiling数据,从设备全局内存中读取预先生成的TCubeTiling结构体,包含关键参数。 流程如下:

      • 初始化算子以及其参数。
      • 调用MatmulCompute计算matmul结果,并写进 reluOutLocal。
      • 调用LeakyReLU函数对 reluOutLocal 中的矩阵进行LeakyReLU激活运算。
    • Tiling实现
      Ascend C提供一组Matmul Tiling API,方便用户获取kernel计算时所需的Tiling参数。只需要传入A/B/C矩阵等信息,调用API接口,即可获取到TCubeTiling结构体中的相关参数。
      获取Tiling参数的流程如下:

      • 创建一个Tiling对象。
      • 设置输入矩阵A、B、输出矩阵C、偏置Bias 的参数类型信息;设置M、N、K形状信息等。
      • 配置多核计算策略
      • 调用GetTiling接口,获取Tiling信息。
    • 调用实现
      使用内核调用符<<<>>>调用核函数。

编译运行

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

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