Matmul实现NBatchMatmul单算子直调样例

概述

本样例介绍了调用Matmul高阶API实现NBatchMatmul单算子，算子实现nNum次批量处理Matmul计算。

支持的产品

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

目录结构介绍

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

算子描述

• 算子功能：
  NBatchMatmul单算子，批量处理Matmul计算，每次Matmul计算对输入的A、B矩阵做矩阵乘和加bias偏置。该算子多Batch复用相同的Bias矩阵。NBatchMatmul算子对BatchMatmul计算批次进行拆分，拆分为nNum个主批次，每个主批次包括BatchNum个子批次的Matmul计算。

• 算子规格：

  本样例中，算子实现支持的shape为：M = 32, N = 256, K = 64。

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

• 算子实现：

  • 约束条件

    • 单Batch Matmul内计算遵循IterateBatch的约束条件；
    • 对于BSNGD、SBNGD、BNGS1S2 Layout格式，输入A、B矩阵多Batch数据总和应该小于L1 Buffer的大小；

  • Kernel实现

    • 计算逻辑：一次完成nNum * BatchNum个Matmul矩阵乘法的运算，单次Matmul的计算公式为：C = A * B + Bias。
      • A、B为源操作数，A为左矩阵，形状为[M, K]；B为右矩阵，形状为[K, N]。
      • C为目的操作数，存放矩阵乘结果的矩阵，形状为[M, N]。
      • Bias为矩阵乘偏置，形状为[1, N]。对A*B结果矩阵的每一行都采用该bias进行偏置。
    • 具体步骤：以异步IterateNbatch计算结果直接输出到GM为例。
      • 创建Matmul对象。 创建Matmul对象时，自定义MatmulConfig参数，将其中的isNBatch参数设置为true，使能多Batch输入和多Batch输出；将其中的isBiasBatch参数设置为false，使能BatchMatmul的Bias复用功能，获得自定义的使用NORM模板的Matmul对象。

        constexpr MatmulConfigMode configMode = MatmulConfigMode::CONFIG_NORM;
        constexpr MatmulBatchParams batchParams = {
          true, BatchMode::BATCH_LESS_THAN_L1, false /* isNBatch， batchMode， isBiasBatch */
        };
        constexpr MatmulConfig CFG_MM = GetMMConfig<configMode>(batchParams);
        AscendC::Matmul<A_TYPE, B_TYPE, C_TYPE, BIAS_TYPE, CFG_PARTIAL> matmulObj;
        

      • 初始化操作。
      • 设置左矩阵A、右矩阵B、Bias。
      • 计算nNum大小，根据A、B矩阵的Layout信息和BatchNum计算nNum大小。

        int32_t g_lay = tiling.ALayoutInfoG > tiling.BLayoutInfoG ? tiling.ALayoutInfoG : tiling.BLayoutInfoG;
        int32_t nNum = tiling.ALayoutInfoB * tiling.ALayoutInfoN * g_lay / tiling.BatchNum;
        

      • 设置workspace。

          matmulObj.SetWorkspace(cGlobal);
        

      • 完成多batch矩阵乘操作，并调用GetBatchTensorC接口获取结果。

        matmulObj.template IterateNBatch<false>(nNum, batchA, batchB, false);
        for(int32_t j = 0; j < nNum; ++j){
            matmulObj.template GetBatchTensorC<false>(batchA, batchB, false);
        }
        

      • 结束矩阵乘操作。

  • Tiling实现

    • Ascend C提供一组Matmul Tiling API，方便用户获取Matmul Kernel计算时所需的 Tiling参数。只需要传入A/B/C矩阵等信息，调用API接口，即可获取到TCubeTiling结构体中的相关参数。
    • 获取Tiling参数的流程如下：
      • 创建一个Tiling对象。
      • 根据输入输出Layout设置单核计算的A、B、C、Bias的参数类型信息；M、N、Ka、Kb形状信息等。
      • 调用SetALayout、SetBLayout、SetCLayout、SetBatchNum设置A/B/C的Layout轴信息和最大BatchNum数。
      • 调用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!