ReGlu

Applicability

Function Usage

ReGlu is a GLU variant. It uses Relu as the activation function. Below is the formula.

The formula for calculating the ReLU activation function is as follows:

Prototype

• Pass the temporary space through the sharedTmpBuffer input parameter.

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

• Allocate the temporary space through the API framework.

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

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 GetReGluMaxMinTmpSize.

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.
• The address of sharedTmpBuffer cannot overlap that of the source or destination operand.
• Currently, only the ND format is supported.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

// dstLocal: tensor for storing the ReGlu computation result
// src0Local: tensor for storing the ReGlu computation input
// src1Local: tensor for storing the ReGlu computation input
// sharedTmpBuffer: tensor for storing the temporary buffer during ReGlu computation

// 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 30.
AscendC::ReGlu(dstLocal, srcLocal, 30);

// 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 30.
AscendC::ReGlu(dstLocal, srcLocal, sharedTmpBuffer, 30);

1
2
3
4
5
6
7
8
9

Input (srcLocal0):
[2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2.
 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2. 2.]
Input (srcLocal1):
[-1.6 -1.5 -1.4 -1.3 -1.2 -1.1 -1.  -0.9 -0.8 -0.7 -0.6 -0.5 -0.4 -0.3 -0.2 -0.1
  0.   0.1  0.2  0.3  0.4  0.5  0.6  0.7  0.8  0.9  1.   1.1  1.2  1.3  1.4  1.5]
Output (dstLocal):
[0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0.  0. 
 0.  0.2 0.4 0.6 0.8 1.  1.2 1.4 1.6 1.8 2.  2.2 2.4 2.6 0.  0. ]