basicBlockMatmul算子样例

概述

本样例介绍了使用Matmul高阶API中basicBlock模版实现矩阵乘算子。

BasicBlock模板的特点：适用于无尾块的特定场景(矩阵的shape可以被base块整除)，可以固定base块大小（baseM/baseN/baseK），减少矩阵搬运和计算过程中的Scalar开销。

支持的产品

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

目录结构介绍

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

算子描述

• 算子功能：

  basicBlockMatmul单算子，对输入的A B矩阵做矩阵乘和加bias偏置

• 算子规格：

  在核函数直调样例中，算子实现支持的shape为：M = 512, N = 1024, K = 512。

  算子类型(OpType)	basicBlockMatmul
  算子输入	name	shape	data type	format	isTrans
  	a	M * K	float16	ND	true
  	b	K * N	float16	ND	false
  	bias	-	float	ND	-
  算子输出	c	M * N	float	ND	-
  核函数名	basic_block_matmul_custom

• 算子实现：

  • Kernel实现

    • 计算逻辑是：Ascend C提供一组Matmul高阶API，方便用户快速实现Matmul矩阵乘法的运算操作。Matmul的计算公式为：C = A * B + Bias。
      • A、B为源操作数，A为左矩阵，形状为[M, K]；B为右矩阵，形状为[K, N]。
      • C为目的操作数，存放矩阵乘结果的矩阵，形状为[M, N]。
      • Bias为矩阵乘偏置，形状为[1, N]。对A*B结果矩阵的每一行都采用该bias进行偏置。
    • 实现MatMul矩阵乘运算的具体步骤如下：
      • 调用GetBasicConfig接口，创建MatmulConfig对象MM_CFG。
      • 调用Matmul接口创建Matmul对象，传入MM_CFG。
      • 调用REGIST_MATMUL_OBJ接口，完成初始化操作。
      • 调用SetTensorA、SetTensorB、SetBias接口，设置左矩阵A、右矩阵B、Bias。
      • 调用Iterate/IterateAll接口，完成矩阵乘操作。
      • 调用End接口，结束矩阵乘操作。

  • Tiling实现

    • Ascend C提供一组Matmul Tiling API，方便用户获取Matmul kernel计算时所需的Tiling参数。只需要传入A/B/C矩阵等信息，调用API接口，即可获取到TCubeTiling结构体中的相关参数。
    • 获取Tiling参数的流程如下：
      • 创建一个Tiling对象。
      • 设置A、B、C、Bias的参数类型信息；M、N、Ka、Kb形状信息等。
      • 调用SetFixSplit接口，设置baseM、baseN、baseK的形状信息。
      • 调用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!