README.md

Transpose样例

概述

本样例基于Transpose高阶API实现将数据排布从NZ格式转换为ND格式并进行维度交换的功能。样例中实现了将NZ格式Tensor转换为ND格式Tensor并交换其第1维和第2维的场景。

本样例支持的产品及CANN软件版本

产品 CANN软件版本
Ascend 950PR/Ascend 950DT >= CANN 9.1.0
Atlas A3 训练系列产品/Atlas A3 推理系列产品 >= CANN 9.0.0
Atlas A2 训练系列产品/Atlas A2 推理系列产品 >= CANN 9.0.0

目录结构介绍

├── transpose
│   ├── scripts
│   │   └── gen_data.py         // 输入数据和真值数据生成脚本
│   ├── CMakeLists.txt          // 编译工程文件
│   ├── data_utils.h            // 数据读入写出函数
│   ├── transpose.asc           // Ascend C样例实现 & 调用样例
│   └── README.md               // 样例说明文档

样例描述

  • 样例功能:
    本样例实现的是使用Transpose高阶API将数据排布从NZ转换到ND并交换ND矩阵第1维和第2维的场景。

  • 样例规格:

    样例类型(OpType)transpose
    样例输入
    nameshapedata typeformat
    x[1, 2, 2, 4, 16, 16]halfNZ
    样例输出
    y[1, 64, 2, 32]halfND
    核函数名transpose_custom
  • 样例实现:
    本样例中实现的是固定shape为输入x[1, 2, 2, 4, 16, 16],输出y[1, 64, 2, 32]的Transpose样例,针对NZ2ND场景,实现1、2轴互换。

    输入shape为[B, N, H/N/16, S/16, 16, 16] = [1, 2, 2, 4, 16, 16]

    经过NZ2ND转换后的shape为[B, N, S, H/N] = [1, 2, 64, 32]

    1轴、2轴转置后的输出shape为[B, S, N, H/N] = [1, 64, 2 ,32]

    • Kernel实现
      使用Transpose高阶API接口完成Transpose计算,得到最终结果,再搬出到外部存储上。

    • Tiling实现
      使用Ascend C提供的GetTransposeTilingInfo接口,获取所需的Tiling参数,并调用GetTransposeMaxMinTmpSize接口获取Transpose接口计算所需的临时空间大小。

    • 调用实现
      使用内核调用符<<<>>>调用核函数。

编译运行

在本样例根目录下执行如下步骤,编译并执行样例。

  • 配置环境变量
    请根据当前环境上CANN开发套件包的安装方式,配置环境变量。

    source ${install_path}/cann/set_env.sh
    

    说明: ${install_path} 为CANN包安装目录,未指定安装目录时默认安装至 /usr/local/Ascend 下。

  • 样例执行

    在本样例目录下执行如下命令。

    mkdir -p build && cd build;      # 创建并进入build目录
    cmake -DCMAKE_ASC_ARCHITECTURES=dav-3510 ..;make -j;    # 编译工程,默认npu模式
    python3 ../scripts/gen_data.py   # 生成测试输入数据
    ./demo                           # 执行编译生成的可执行程序,执行样例
    python3 ../scripts/verify_result.py output/output.bin output/golden.bin   # 验证输出结果是否正确,确认算法逻辑正确
    

    使用 CPU调试 或 NPU仿真 模式时,添加 -DCMAKE_ASC_RUN_MODE=cpu-DCMAKE_ASC_RUN_MODE=sim 参数即可。

    示例如:

    cmake -DCMAKE_ASC_RUN_MODE=cpu -DCMAKE_ASC_ARCHITECTURES=dav-3510 ..;make -j; # cpu调试模式
    cmake -DCMAKE_ASC_RUN_MODE=sim -DCMAKE_ASC_ARCHITECTURES=dav-3510 ..;make -j; # NPU仿真模式
    

    注意: 切换编译模式前需清理 cmake 缓存,可在 build 目录下执行 rm CMakeCache.txt 后重新 cmake。

  • 编译选项说明

    选项 可选值 说明
    CMAKE_ASC_RUN_MODE npu(默认)、cpusim 运行模式:NPU 运行、CPU调试、NPU仿真
    CMAKE_ASC_ARCHITECTURES dav-3510(默认)、dav-2201 NPU 架构:dav-2201 对应 Atlas A2 训练系列产品/Atlas A2 推理系列产品和 Atlas A3 训练系列产品/Atlas A3 推理系列产品,dav-3510 对应 Ascend 950PR/Ascend 950DT
  • 执行结果

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

    test pass!