CANN/asc-devkit：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 推理系列产品	√

功能说明

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

Deq的计算公式如下：

如上公式先除以2^17再乘以2^17用于防止x乘以DeqScale出现溢出情况；公式中DeqScale需要通过SetDeqScale进行设置，具体可参考SetDeqScale。

函数原型

• 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模板参数说明

参数名	描述
isSetMask	是否在接口内部设置mask。 true，表示在接口内部设置mask。 false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为占位符MASK_PLACEHOLDER。
T	目的操作数的数据类型。 Ascend 950PR/Ascend 950DT，支持的数据类型为：half Atlas A3 训练系列产品 / Atlas A3 推理系列产品，支持的数据类型为：half Atlas A2 训练系列产品 / Atlas A2 推理系列产品，支持的数据类型为：half
U	源操作数的数据类型。 Ascend 950PR/Ascend 950DT，支持的数据类型为：int32_t Atlas A3 训练系列产品 / Atlas A3 推理系列产品，支持的数据类型为：int32_t Atlas A2 训练系列产品 / Atlas A2 推理系列产品，支持的数据类型为：int32_t

表 2参数说明

参数名	输入/输出	描述
dst	输出	目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。
src0、src1	输入	源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。
count	输入	参与计算的元素个数。
mask[]/mask	输入	mask用于控制每次迭代内参与计算的元素。 逐bit模式：可以按位控制哪些元素参与计算，bit位的值为1表示参与计算，0表示不参与。 mask为数组形式，数组长度和数组元素的取值范围和操作数的数据类型有关。当操作数为16位时，数组长度为2，mask[0]、mask[1]∈[0, 264-1]并且不同时为0；当操作数为32位时，数组长度为1，mask[0]∈(0, 264-1]；当操作数为64位时，数组长度为1，mask[0]∈(0, 232-1]。 例如，mask=[8, 0]，8=0b1000，表示仅第4个元素参与计算。 连续模式：表示前面连续的多少个元素参与计算。取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask∈[1, 128]；当操作数为32位时，mask∈[1, 64]；当操作数为64位时，mask∈[1, 32]。 当源操作数和目的操作数位数不同时，以数据类型的字节较大的为准。
repeatTime	输入	重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。
repeatParams	输入	控制操作数地址步长的参数。BinaryRepeatParams类型，包含操作数相邻迭代间相同datablock的地址步长，操作数同一迭代内不同datablock的地址步长等参数。

返回值说明

无

约束说明

• 操作数地址对齐要求请参见通用地址对齐约束。
• 不支持目的操作数和源操作数地址重叠。

调用示例

本样例的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