Erf

产品支持情况

功能说明

按元素做误差函数计算（也称为高斯误差函数，error function or Gauss error function）。计算公式如下：

函数原型

• 通过sharedTmpBuffer入参传入临时空间

  • 源操作数Tensor全部/部分参与计算

    template <typename T, bool isReuseSource = false, const ErfConfig& config = defaultErfConfig>
    __aicore__ inline void Erf(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const uint32_t calCount)
    

  • 源操作数Tensor全部参与计算

    template <typename T, bool isReuseSource = false, const ErfConfig& config = defaultErfConfig>
    __aicore__ inline void Erf( const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer)
    

• 接口框架申请临时空间

  • 源操作数Tensor全部/部分参与计算

    template <typename T, bool isReuseSource = false, const ErfConfig& config = defaultErfConfig>
    __aicore__ inline void Erf(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const uint32_t calCount)
    

  • 源操作数Tensor全部参与计算

    template <typename T, bool isReuseSource = false, const ErfConfig& config = defaultErfConfig>
    __aicore__ inline void Erf(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor)
    

由于该接口的内部实现中涉及复杂的数学计算，需要额外的临时空间来存储计算过程中的中间变量。临时空间支持开发者通过sharedTmpBuffer入参传入和接口框架申请两种方式。

• 通过sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理sharedTmpBuffer内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。
• 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。

通过sharedTmpBuffer传入的情况，开发者需要为tensor申请空间；接口框架申请的方式，开发者需要预留临时空间。临时空间大小BufferSize的获取方式如下：通过GetErfMaxMinTmpSize接口获取需要预留空间范围的大小。

参数说明

表 1 模板参数说明

enum class ErfAlgo {
    PADE_APPROXIMATION = 0,
    SUBSECTION_POLYNOMIAL_APPROXIMATION,
};

struct ErfConfig {
    ErfAlgo algo = ErfAlgo::PADE_APPROXIMATION;
};

表 2 接口参数说明

返回值说明

无

约束说明

• 不支持源操作数与目的操作数地址重叠。

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

调用示例

#include "kernel_operator.h"

template <typename srcType>
class KernelErf {
public:
    __aicore__ inline KernelErf()
    {}
    __aicore__ inline void Init(GM_ADDR srcGm, GM_ADDR dstGm, uint32_t srcSize)
    {
        srcGlobal.SetGlobalBuffer(reinterpret_cast<__gm__ srcType *>(srcGm), srcSize);
        dstGlobal.SetGlobalBuffer(reinterpret_cast<__gm__ srcType *>(dstGm), srcSize);

        pipe.InitBuffer(inQueueX, 1, srcSize * sizeof(srcType));
        pipe.InitBuffer(outQueue, 1, srcSize * sizeof(srcType));
    }
    __aicore__ inline void Process(uint32_t offset, uint32_t calSize)
    {
        bufferSize = calSize;
        CopyIn(offset);
        Compute();
        CopyOut(offset);
    }
private:
    __aicore__ inline void CopyIn(uint32_t offset)
    {
        AscendC::LocalTensor<srcType> srcLocal = inQueueX.AllocTensor<srcType>();
        AscendC::DataCopy(srcLocal, srcGlobal[offset], bufferSize);
        inQueueX.EnQue(srcLocal);
    }
    __aicore__ inline void Compute()
    {
        AscendC::LocalTensor<srcType> dstLocal = outQueue.AllocTensor<srcType>();
        AscendC::LocalTensor<srcType> srcLocal = inQueueX.DeQue<srcType>();
        AscendC::Erf<srcType, false>(dstLocal, srcLocal);
        // static constexpr AscendC::ErfAlgo algo = AscendC::ErfAlgo::SUBSECTION_POLYNOMIAL_APPROXIMATION;
        // static constexpr AscendC::ErfConfig config = { algo };
        // AscendC::Erf<srcType, false，config>(dstLocal, srcLocal);
        outQueue.EnQue<srcType>(dstLocal);
        inQueueX.FreeTensor(srcLocal);
    }
    __aicore__ inline void CopyOut(uint32_t offset)
    {
        AscendC::LocalTensor<srcType> dstLocal = outQueue.DeQue<srcType>();
        AscendC::DataCopy(dstGlobal[offset], dstLocal, bufferSize);
        outQueue.FreeTensor(dstLocal);
    }
private:
    AscendC::GlobalTensor<srcType> srcGlobal;
    AscendC::GlobalTensor<srcType> dstGlobal;
    AscendC::TPipe pipe;
    AscendC::TQue<AscendC::TPosition::VECIN, 1> inQueueX;
    AscendC::TQue<AscendC::TPosition::VECOUT, 1> outQueue;
    uint32_t bufferSize = 0;
};

template <typename dataType>
__aicore__ void kernel_erf_operator(GM_ADDR srcGm, GM_ADDR dstGm, uint32_t srcSize)
{
    KernelErf<dataType> op;
    op.Init(srcGm, dstGm, srcSize);
    op.Process();
}

结果示例如下：

输入数据(srcLocal): [2.015634 , -2.3880906, -0.2151161, ..., -2.5      ,  0.       ,  2.5]
输出数据(dstLocal): [0.99563545, -0.999268  , -0.23903976, ..., -0.9995931 ,  0.        ,  0.9995931]