Documentation

Tanh

Function Description

Performs logistic regression Tanh element-wise using the following formula, where PAR indicates the number of elements that can be processed by a vector unit in one iteration.

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 Tanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, 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 Tanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, 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 Tanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const uint32_t calCount)
    • All source operand tensors are involved in computation.
      1
2
      template <typename T, bool isReuseSource = false>
__aicore__ inline void Tanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor)

Parameters

Table 1 Parameters in the template

Parameter

Description

T

Data type of the operand.

isReuseSource

Whether the source operand can be modified. This parameter is reserved. Pass the default value false.
Table 2 API parameters

Parameter

Input/Output

Description

dstTensor

Output

Destination operand.

The type is LocalTensor, and the supported TPosition is VECIN, VECCALC, or VECOUT.

srcTensor

Input

Source operand.

The type is LocalTensor, and the supported TPosition is VECIN, VECCALC, or VECOUT.

The source operand must have the same data type as the destination operand.

sharedTmpBuffer

Input

Temporary buffer.

The type is LocalTensor, and the supported TPosition is VECIN, VECCALC, or VECOUT.

This parameter is used to store intermediate variables during complex computation in Tanh and is provided by developers.

For details about how to obtain the temporary space size (BufferSize), see GetTanhMaxMinTmpSize.

calCount

Input

Number of actually computed data elements. The value range is [0, srcTensor.GetSize()].

Returns

None

Availability

Constraints

  • The source operand address must not overlap the destination operand address.
  • sharedTmpBuffer must not overlap the addresses of the source operand and destination operand.
  • For details about the alignment requirements of the operand address offset, see General Restrictions.

Example

For details about the complete call example, see More Examples.
1
2
3
4
5
6
AscendC::TPipe pipe;
AscendC::TQue<AscendC::TPosition::VECCALC, 1> tmpQue;
pipe.InitBuffer(tmpQue, 1, bufferSize);  // bufferSize is obtained through the tiling parameter on the host.
AscendC::LocalTensor<uint8_t> sharedTmpBuffer = tmpQue.AllocTensor<uint8_t>();
// The input shape is 1024, the input data type of the operator is half, and the actually computed data elements is 512.
AscendC::Tanh(dstLocal, srcLocal, sharedTmpBuffer, 512);
Result example:
1
2
3
Input data (srcLocal): [1.762616 7.9542747 ... 7.8306146 6.3167496]
Output data (dstLocal):
[0.9427944   0.9999998 ... 0.9999996 0.9999934]
Parent topic: Tanh