SwiGLU

Applicability

Function Usage

SwiGLU is a GLU variant that uses Swish as the activation function. Below is the formula.

The formula of the Swish activation function is as follows (β is a constant):

Prototype

• Pass the temporary space through the sharedTmpBuffer input parameter.
  • All or part of the source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void SwiGLU(LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor0, const LocalTensor<T>& srcTensor1, const float& scalarValue, const LocalTensor<uint8_t>& sharedTmpBuffer, const uint32_t calCount)

  • All source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void SwiGLU(LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor0, const LocalTensor<T>& srcTensor1, const float& scalarValue, const LocalTensor<uint8_t>& sharedTmpBuffer)

• Allocate the temporary space through the API framework.
  • All or part of the source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void SwiGLU(LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor0, const LocalTensor<T>& srcTensor1, const float& scalarValue, const uint32_t calCount)

  • All source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void SwiGLU(LocalTensor<T>& dstTensor, LocalTensor<T>& srcTensor0, LocalTensor<T>& srcTensor1, const float& scalarValue)

Due to the complex mathematical computation involved in the internal implementation of this API, extra temporary space is required to store intermediate variables generated during computation. The temporary space can be passed by developers through the sharedTmpBuffer input parameter or allocated through the API framework.

• When the sharedTmpBuffer input parameter is used for passing the temporary space, the tensor serves as the temporary space. In this case, the API framework is not required for temporary space allocation. This enables developers to manage the sharedTmpBuffer space and reuse the buffer after calling the API, so that the buffer is not repeatedly allocated or deallocated, improving the flexibility and buffer utilization.
• When the API framework is used for temporary space allocation, developers do not need to allocate the space, but must reserve the required size for the temporary space.

If sharedTmpBuffer is used, developers must allocate space for the tensor. If the API framework is used, developers must reserve the temporary space. To obtain the size of the temporary space (BufferSize) to be reserved, use the API provided in GetSwiGLUMaxMinTmpSize.

Parameters

Returns

None

Constraints

• For details about the operand address alignment requirements, see General Address Alignment Restrictions.
• The source operand address must not overlap the destination operand address.
• Currently, only the ND format is supported.
• The address of sharedTmpBuffer cannot overlap that of the source or destination operand.

Examples

For a complete operator sample, see swiglu operator sample.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

// dstLocal: tensor for storing the SwiGLU computation result
// src0Local: tensor for storing the SwiGLU computation input
// src1Local: tensor for storing the SwiGLU computation input
// scalarValue: β in the activation function
// sharedTmpBuffer: tensor for storing the temporary buffer during SwiGLU computation

float scalarValue = 1.0;

// Allocate the temporary space through the API framework, all of which is used for computation.
AscendC::SwiGLU(dstLocal, src0Local, src1Local, scalarValue);
// Allocate the temporary space through the API framework, part of which is used for computation, with the number of elements involved in the computation being 32.
AscendC::SwiGLU(dstLocal, src0Local, src1Local, scalarValue, 32);

// Pass the temporary space through the sharedTmpBuffer input parameter, all of which is used for computation.
AscendC::SwiGLU(dstLocal, src0Local, src1Local, scalarValue, sharedTmpBuffer);
// Pass the temporary space through the sharedTmpBuffer input parameter, part of which is used for computation, with the number of elements involved in computation being 32.
AscendC::SwiGLU(dstLocal, src0Local, src1Local, scalarValue, sharedTmpBuffer, 32);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

Input (srcTensor0):
[-4.         -3.7419355  -3.483871   -3.2258065  -2.967742   -2.7096775  -2.451613   -2.1935484
 -1.9354838  -1.6774193  -1.4193548  -1.1612903  -0.9032258  -0.6451613  -0.38709676 -0.12903225
  0.12903225  0.38709676  0.6451613   0.9032258   1.1612903   1.4193548   1.6774193   1.9354838
  2.1935484   2.451613    2.7096775   2.967742    3.2258065   3.483871    3.7419355   4.        ]
Input (srcTensor1):
[0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5
 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5 0.5]
Output (dstLocal):
[-1.2449187  -1.1646013  -1.084284   -1.0039667  -0.9236493  -0.843332   -0.7630147  -0.68269736
 -0.60238    -0.52206266 -0.4417453  -0.361428   -0.28111064 -0.20079333 -0.12047599 -0.04015867
  0.04015867  0.12047599  0.20079333  0.28111064  0.361428    0.4417453   0.52206266  0.60238
  0.68269736  0.7630147   0.843332    0.9236493   1.0039667   1.084284    1.1646013   1.2449187 ]