README.md

LogSoftMax样例

概述

本样例在多分类任务场景下,基于LogSoftMax高阶API对输入Tensor做LogSoftmax计算。该API常用于多分类任务的输出层,与交叉熵损失函数配合使用,其数值稳定性优于直接计算log(softmax(x))。计算过程包括:对last轴求行最大值、用输入减去最大值后求exp、最后将exp结果按行归一化并做log10计算。本样例使用float数据类型,输入Tensor shape为[128, 128],完成LogSoftmax激活计算。

本样例支持的产品及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

目录结构介绍

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

样例描述

  • 样例功能: 对输入Tensor做LogSoftmax计算。

    计算公式如下:

    dsti=LogSoftMax(srci)dst_i = LogSoftMax(src_i)

    LogSoftmax(xi)=log⁡(exp⁡(xi)∑jexp⁡(xj))LogSoftmax(x_i)=\log(\frac{\exp(x_i)}{\sum_j \exp(x_j)})

  • 样例规格:

表1:样例规格表
样例类型(OpType) logsoftmax
样例输入
nameshapedata typeformat
src[128, 128]floatND
样例输出
dst[128, 128]floatND
核函数名logsoftmax_custom
  • 样例实现:
    本样例中实现的是固定shape为输入src[128, 128],输出dst[128, 128]的logsoftmax_custom样例。

    • Kernel实现
      核心计算步骤:将输入数据搬入后,调用 AscendC::LogSoftMax 完成 LogSoftMax 计算,再将结果搬出。

    • Tiling实现
      本样例为单核计算场景,无复杂分核逻辑。Host端通过 AscendC::GetLogSoftMaxMinTmpSize 获取API所需临时缓冲区大小,Kernel内部使用 LogSoftMaxTiling 结构体传递API所需的tiling参数。

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

编译运行

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

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

    source ${install_path}/cann/set_env.sh
    

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

  • 样例执行

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

    mkdir -p build && cd build;
    cmake -DCMAKE_ASC_ARCHITECTURES=dav-2201 ..;make -j; # 默认npu模式
    python3 ../scripts/gen_data.py
    ./demo
    

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

    示例如下:

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

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

  • 编译选项说明

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

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

    test pass!