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算子Iterate异步场景直调样例

概述

本样例介绍调用Matmul API实现异步场景下的Matmul矩阵乘法，实现方式为调用Iterate和GetTensorC输出到VECIN。
异步场景指的是程序执行时，不需要等待某个操作完成就可以执行下一步操作。异步场景可以减少同步等待，提高并行度，开发者对计算性能要求较高时，可以选用该方式。

支持的产品

Ascend 950PR/Ascend 950DT
Atlas A3 训练系列产品/Atlas A3 推理系列产品
Atlas A2 训练系列产品/Atlas A2 推理系列产品

目录结构介绍

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

算子描述

算子功能：

Matmul算子实现调用Iterate和GetTensorC输出到VECIN的异步场景矩阵乘计算。

算子规格：

算子类型(OpType)	Matmul
算子输入	name	shape	data type	format	isTrans
	a	(640, 512)	half	ND	false
	b	(512, 1024)	half	ND	false
	bias	(1024, )	float	ND	-
算子输出	c	(640, 1024)	float	ND	-
核函数名	matmul_custom

算子实现：

Kernel实现

计算逻辑：C = A * B + Bias。
- A、B为源操作数，A为左矩阵，形状为[M, K]；B为右矩阵，形状为[K, N]。
- C为目的操作数，存放矩阵乘结果的矩阵，形状为[M, N]。
- Bias为矩阵乘偏置，形状为[1, N]。对A*B结果矩阵的每一行都采用该Bias进行偏置。

具体步骤：

创建Matmul对象，输出C矩阵的TPosition为VECIN。

AscendC::Matmul<AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, AType>,
AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BType>,
AscendC::MatmulType<AscendC::TPosition::VECIN, CubeFormat::ND, CType>,
AscendC::MatmulType<AscendC::TPosition::GM, CubeFormat::ND, BiasType>, CFG_MDL> matmulObj;

初始化操作。
设置左矩阵A、右矩阵B、Bias。

获取矩阵乘计算结果。

matmulObj.SetWorkspace(workspaceGlobal);
matmulObj.template Iterate<false>();
uint32_t baseM = this->tiling.baseM;
uint32_t baseN = this->tiling.baseN;
pipe->InitBuffer(cInQueue, 1, baseM * baseN * sizeof(CType));
pipe->InitBuffer(cOutQueue, 1, baseM * baseN * sizeof(CType));
AscendC::DataCopyParams copyParams = {
    (uint16_t)baseM,
    (uint16_t)(baseN * sizeof(CType) / AscendC::DEFAULT_C0_SIZE),
    (uint16_t)0,
    (uint16_t)((this->tiling.N - baseN) * sizeof(CType) / AscendC::DEFAULT_C0_SIZE)
};
uint32_t iterateTimes = Ceiling(this->tiling.singleCoreM, baseM) * Ceiling(this->tiling.singleCoreN, baseN);
for (uint32_t i = 0; i < iterateTimes; ++i) {
    // compute
    auto cInLocal = cInQueue.AllocTensor<CType>();
    matmulObj.template GetTensorC<false>(cInLocal);
    cInQueue.EnQue(cInLocal);
    // any vector operator
    auto src = cInQueue.DeQue<CType>();
    auto dst = cOutQueue.AllocTensor<CType>();
    DataCopy(dst, src, baseM * baseN);
    cOutQueue.EnQue(dst);
    cInQueue.FreeTensor(src);
    // copy out
    auto cOutLocal = cOutQueue.DeQue<CType>();
    DataCopy(cGlobal[CalcDstOffset(i)], cOutLocal, copyParams);
    cOutQueue.FreeTensor(cOutLocal);
}

完成矩阵乘操作。
结束矩阵乘操作。

Tiling实现
- Ascend C提供一组Matmul Tiling API，方便用户获取Matmul kernel计算时所需的Tiling参数。只需要传入A/B/C矩阵等信息，调用API接口，即可获取到TCubeTiling结构体中的相关参数。
- 获取Tiling参数的流程如下：
  - 创建一个Tiling对象。
  - 设置A、B、C、Bias的参数类型信息；M、N、Ka、Kb形状信息等。设置C的TPosition为VECIN。
```
cubeTiling->SetCType(matmul_tiling::TPosition::VECIN, matmul_tiling::CubeFormat::ND, matmul_tiling::DataType::DT_FLOAT);
```
  - 调用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!