cann-robotReplace blockDim with numBlocks

文件	最后提交记录	最后更新时间
scripts	libraries && best_practices sample	4 个月前
CMakeLists.txt	libraries && best_practices sample	4 个月前
README.md	libraries && best_practices sample	4 个月前
data_utils.h	libraries && best_practices sample	4 个月前
matmul.asc	Replace blockDim with numBlocks	4 个月前

Matmul算子开启A2和B2全局管理直调样例

概述

本样例介绍调用Matmul API实现开启A2和B2全局管理的单算子。其中A2和B2的全局管理为，算子中所有Matmul对象共享A2和B2。

支持的产品

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

目录结构介绍

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

算子描述

算子功能：

Matmul算子算子中包含两次Matmul计算，两次Matmul计算有不同的左矩阵、右矩阵，相同的bias，通过设置每个Matmul对象中MatmulConfig的isA2B2Shared参数值为true，开启A2和B2的全局管理，即所有Matmul对象共享A2和B2，提高算子性能。

算子规格：

本样例默认执行的算子shape为：M = 7680, N = 480, K = 320。

算子类型(OpType)	Matmul
算子输入	name	shape	data type	format	isTrans
	a1	M * K	half	ND	false
	b1	K * N	half	ND	false
	a2	M * K	half	ND	false
	b2	K * N	half	ND	false
	bias	N	float	ND	-
算子输出	c1	M * N	float	ND	-
算子输出	c2	M * N	float	ND	-
核函数名	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矩阵乘运算的具体步骤如下：
    - 创建MatmulConfig对象，配置NORM模板，设置isA2B2Shared参数值为true，创建两个Matmul对象。
```
// In the first matmul calculation, `a1 * b1 + bias = c1`.
AscendC::Matmul<AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, AType, IS_TRANS_A>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BType, IS_TRANS_B>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, CType>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BiasType>, CFG_MDL>
    matmulObj1;
// In the second matmul calculation, `a2 * b2 + bias = c2`.
AscendC::Matmul<AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, AType, IS_TRANS_A>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BType, IS_TRANS_B>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, CType>,
                AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BiasType>, CFG_MDL>
    matmulObj2;
```
    - 初始化操作。
    - 设置两次矩阵乘的左矩阵A1、A2、右矩阵B1、B2，共用Bias。
```
matmulObj1.SetTensorA(a1Global);
matmulObj1.SetTensorB(b1Global);
matmulObj2.SetTensorA(a2Global);
matmulObj2.SetTensorB(b2Global);
if (tiling.isBias) {
    matmulObj1.SetBias(biasGlobal);
    matmulObj2.SetBias(biasGlobal);
}
matmulObj1.IterateAll(c1Global);
matmulObj1.End();
matmulObj2.IterateAll(c2Global);
matmulObj2.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形状信息等。
    - 调用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/output1.bin output/golden1.bin output/output2.bin output/golden2.bin  # 验证输出结果是否正确，确认算法逻辑正确

执行结果如下，说明精度对比成功。

test pass!