CANN Ascend C AddDeqRelu API文档

AddDeqRelu

【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言，原生支持C和C++标准规范，主要由类库和语言扩展层构成，提供多层级API，满足多维场景算子开发诉求。项目地址: https://gitcode.com/cann/asc-devkit

产品支持情况

• Ascend 950PR/Ascend 950DT：支持

• Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持

• Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持

• Atlas 200I/500 A2 推理产品：不支持

• Atlas 推理系列产品 AI Core：支持

• Atlas 推理系列产品 Vector Core：不支持

• Atlas 训练系列产品：不支持

功能说明

头文件路径为："basic_api/kernel_operator_vec_binary_intf.h"。

依次计算按元素求和、结果进行deq量化后再进行relu计算（结果和0对比取较大值）。计算公式如下：

$$ dst_i = Relu(Deq(src0_i + src1_i)) $$

Deq的计算公式如下，采用RINT舍入方式，scale需要通过SetDeqScale进行设置：

$$ Deq(x) = Cast(x \times scale) $$

其中Relu的计算公式如下：

$$ Relu(x) = max(0, x) $$

函数原型

• tensor前n个数据计算

  __aicore__ inline void AddDeqRelu(const LocalTensor<half>& dst, const LocalTensor<int32_t>& src0, const LocalTensor<int32_t>& src1, const int32_t& count)

• tensor高维切分计算

  • mask逐bit模式

    template <bool isSetMask = true> __aicore__ inline void AddDeqRelu(const LocalTensor<half>& dst, const LocalTensor<int32_t>& src0, const LocalTensor<int32_t>& src1, uint64_t mask[], const uint8_t repeatTime, const BinaryRepeatParams& repeatParams)

  • mask连续模式

    template <bool isSetMask = true> __aicore__ inline void AddDeqRelu(const LocalTensor<half>& dst, const LocalTensor<int32_t>& src0, const LocalTensor<int32_t>& src1, uint64_t mask, const uint8_t repeatTime, const BinaryRepeatParams& repeatParams)

操作数使用TensorTrait类型时，LocalTensor需要输入模板参数。提供支持操作数数据类型作为模板参数传入的接口如下：

• tensor前n个数据计算

  template <typename T, typename U> __aicore__ inline void AddDeqRelu(const LocalTensor<T>& dst, const LocalTensor<U>& src0, const LocalTensor<U>& src1, const int32_t& count)

• tensor高维切分计算

  • mask逐bit模式

    template <typename T, typename U, bool isSetMask = true> __aicore__ inline void AddDeqRelu(const LocalTensor<T>& dst, const LocalTensor<U>& src0, const LocalTensor<U>& src1, uint64_t mask[], const uint8_t repeatTime, const BinaryRepeatParams& repeatParams)

  • mask连续模式

    template <typename T, typename U, bool isSetMask = true> __aicore__ inline void AddDeqRelu(const LocalTensor<T>& dst, const LocalTensor<U>& src0, const LocalTensor<U>& src1, uint64_t mask, const uint8_t repeatTime, const BinaryRepeatParams& repeatParams)

参数说明

表1模板参数说明

表2参数说明

数据类型

表3数据类型组合情况

返回值说明

无

约束说明

• 操作数地址对齐要求请参见通用地址对齐约束。
• 操作数地址重叠约束请参考通用地址重叠约束。

• 当参数count或repeatTime取值为0时，该接口的行为如下：
  • 针对如下型号，该接口不会执行计算操作，不会对目的操作数进行写入，该接口将被视为NOP（空操作）。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品
    • Atlas A2 训练系列产品/Atlas A2 推理系列产品
  • 针对Ascend 950PR/Ascend 950DT，该接口通过VF调用Reg矢量计算API实现兼容，当参数count或repeatTime取值为0时，不保证该接口将被视为NOP（空操作）。

• 该接口需要与SetDeqScale配合使用，关系映射表如下：

  AddDeqRelu使用场景	对应使用的SetDeqScale函数原型
  输入类型为int32_t	__aicore__ inline void SetDeqScale(half scale)

• 本接口涉及临时空间的使用，计算公式如下，当计算数据量小于等于2K（2048）时，使用的临时空间与计算数据量线性相关，当数据量大于2K时，临时空间大小固定为8KB： $$ tmpSize = \begin{cases} count * sizeof(int32_t), & \text{if } count \le 2K \ 8K, & \text{if } count \gt 2K \end{cases} $$

关键特性

溢出保护

该接口在执行int32_t到half数据类型的反量化时，会进行防溢出保护处理： $$Deq(x) = Cast(x \times (1/2^{17}) \times scale \times 2^{17}) = Cast(x \times scale)$$ 中间缩小步骤将数值控制在安全范围内，有效避免了浮点溢出。

调用示例

本样例的srcLocal为int32_t类型，dstLocal为half类型，计算mask时以int32_t为准。

• tensor高维切分计算样例-mask连续模式。

  uint64_t mask = 256 / sizeof(int32_t); // 64 // repeatTime = 4，一次迭代计算64个数，共计算256个数 // dstBlkStride, src0BlkStride, src1BlkStride = 1，单次迭代内数据连续读取和写入 // dstRepStride = 4，src0RepStride, src1RepStride = 8，相邻迭代间数据连续读取和写入 half scale = 0.1; AscendC::SetDeqScale(scale); AscendC::AddDeqRelu(dstLocal, src0Local, src1Local, mask, 4, { 1, 1, 1, 4, 8, 8 });

• tensor高维切分计算样例-mask逐bit模式。

  uint64_t mask[2] = { UINT64_MAX, UINT64_MAX }; // repeatTime = 4，一次迭代计算64个数，共计算256个数 // dstBlkStride, src0BlkStride, src1BlkStride = 1，单次迭代内数据连续读取和写入 // dstRepStride = 4，src0RepStride, src1RepStride = 8，相邻迭代间数据连续读取和写入 half scale = 0.1; AscendC::SetDeqScale(scale); AscendC::AddDeqRelu(dstLocal, src0Local, src1Local, mask, 4, { 1, 1, 1, 4, 8, 8 });

• tensor前n个数据计算样例。

  half scale = 0.1; AscendC::SetDeqScale(scale); AscendC::AddDeqRelu(dstLocal, src0Local, src1Local, 512);

结果示例如下：

输入数据src0Local：[70 36 43 54 28 49 27 82 95 ...] 输入数据src1Local：[19 33 34 50 42 2 97 93 99 ...] 输出数据dstLocal：[8.9 6.9 7.7 10.4 7.0 5.1 12.4 17.5 19.4 ...]

【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言，原生支持C和C++标准规范，主要由类库和语言扩展层构成，提供多层级API，满足多维场景算子开发诉求。项目地址: https://gitcode.com/cann/asc-devkit