cann-robotlibraries && best_practices sample

Matmul IBShareB算子直调样例

概述

本样例介绍了调用Matmul高阶API实现开启IBShare功能的单算子。IBShare的功能是复用L1 Buffer上相同的A矩阵或者B矩阵数据，减少数据搬运开销。本样例为仅B矩阵复用场景。

支持的产品

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

目录结构介绍

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

算子描述

算子功能：

MatmulIBShareBCustom算子通过调用Matmul高阶API，开启B矩阵的IBShare功能，对输入的A、B矩阵做矩阵乘和加bias偏置。

算子规格：

本样例默认执行的算子shape为：M = 64, N = 256, K = 384。

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

算子实现：

本样例是仅B矩阵使能IBShare的场景，计算过程中同一AIC对应的两个AIV在每次迭代时用到的B矩阵数据都一致。
- 约束条件：
  - A矩阵或B矩阵单独使能IBShare的场景，要求复用的矩阵必须在L1 Buffer上全载。
- 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对象，设置B矩阵的IBShare参数为true，使用默认的IBShare模板CFG_IBSHARE_NORM创建Matmul对象。
```
using A_TYPE = AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, AType>;
using B_TYPE = AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BType, false, LayoutMode::NONE, true>;
using C_TYPE = AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, CType>;
using BIAS_TYPE = AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BiasType>;
AscendC::Matmul<A_TYPE, B_TYPE, C_TYPE, BIAS_TYPE, CFG_IBSHARE_NORM> matmulObj;
```
    - 初始化操作。
    - 设置左矩阵A、右矩阵B、Bias。
    - 完成矩阵乘操作。
    - 结束矩阵乘操作。
- Tiling实现
  - Ascend C提供一组Matmul Tiling API，方便用户获取Matmul kernel计算时所需的Tiling参数。只需要传入A/B/C矩阵等信息，调用API接口，即可获取到TCubeTiling结构体中的相关参数。
  - 获取Tiling参数的流程如下：
    - 创建一个Tiling对象。
    - 设置A、B、C、Bias的参数类型信息；M、N、Ka、Kb形状信息等。
    - 调用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!