Compute Library
 20.02.1
ActivationLayerInfo Class Reference

Activation Layer Information class. More...

#include <Types.h>

Public Types

enum  ActivationFunction {
  LOGISTIC, TANH, RELU, BOUNDED_RELU,
  LU_BOUNDED_RELU, LEAKY_RELU, SOFT_RELU, ELU,
  ABS, SQUARE, SQRT, LINEAR,
  IDENTITY
}
 Available activation functions. More...
 

Public Member Functions

 ActivationLayerInfo ()=default
 
 ActivationLayerInfo (ActivationFunction f, float a=0.0f, float b=0.0f)
 Default Constructor. More...
 
ActivationFunction activation () const
 Get the type of activation function. More...
 
float a () const
 Get the alpha value. More...
 
float b () const
 Get the beta value. More...
 
bool enabled () const
 Check if initialised. More...
 

Detailed Description

Activation Layer Information class.

Definition at line 1615 of file Types.h.

Member Enumeration Documentation

◆ ActivationFunction

enum ActivationFunction
strong

Available activation functions.

Enumerator
LOGISTIC 

Logistic ( \( f(x) = \frac{1}{1 + e^{-x}} \) )

TANH 

Hyperbolic tangent ( \( f(x) = a \cdot tanh(b \cdot x) \) )

RELU 

Rectifier ( \( f(x) = max(0,x) \) )

BOUNDED_RELU 

Upper Bounded Rectifier ( \( f(x) = min(a, max(0,x)) \) )

LU_BOUNDED_RELU 

Lower and Upper Bounded Rectifier ( \( f(x) = min(a, max(b,x)) \) )

LEAKY_RELU 

Leaky Rectifier ( \( f(x) = \begin{cases} \alpha x & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \) )

SOFT_RELU 

Soft Rectifier ( \( f(x)= log(1+e^x) \) )

ELU 

Exponential Linear Unit ( \( f(x) = \begin{cases} \alpha (exp(x) - 1) & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \) )

ABS 

Absolute ( \( f(x)= |x| \) )

SQUARE 

Square ( \( f(x)= x^2 \) )

SQRT 

Square root ( \( f(x) = \sqrt{x} \) )

LINEAR 

Linear ( \( f(x)= ax + b \) )

IDENTITY 

Identity ( \( f(x)= x \) )

Definition at line 1619 of file Types.h.

1620  {
1621  LOGISTIC, /**< Logistic ( \f$ f(x) = \frac{1}{1 + e^{-x}} \f$ ) */
1622  TANH, /**< Hyperbolic tangent ( \f$ f(x) = a \cdot tanh(b \cdot x) \f$ ) */
1623  RELU, /**< Rectifier ( \f$ f(x) = max(0,x) \f$ ) */
1624  BOUNDED_RELU, /**< Upper Bounded Rectifier ( \f$ f(x) = min(a, max(0,x)) \f$ ) */
1625  LU_BOUNDED_RELU, /**< Lower and Upper Bounded Rectifier ( \f$ f(x) = min(a, max(b,x)) \f$ ) */
1626  LEAKY_RELU, /**< Leaky Rectifier ( \f$ f(x) = \begin{cases} \alpha x & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \f$ ) */
1627  SOFT_RELU, /**< Soft Rectifier ( \f$ f(x)= log(1+e^x) \f$ ) */
1628  ELU, /**< Exponential Linear Unit ( \f$ f(x) = \begin{cases} \alpha (exp(x) - 1) & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \f$ ) */
1629  ABS, /**< Absolute ( \f$ f(x)= |x| \f$ ) */
1630  SQUARE, /**< Square ( \f$ f(x)= x^2 \f$ )*/
1631  SQRT, /**< Square root ( \f$ f(x) = \sqrt{x} \f$ )*/
1632  LINEAR, /**< Linear ( \f$ f(x)= ax + b \f$ ) */
1633  IDENTITY /**< Identity ( \f$ f(x)= x \f$ ) */
1634  };

Constructor & Destructor Documentation

◆ ActivationLayerInfo() [1/2]

ActivationLayerInfo ( )
default

◆ ActivationLayerInfo() [2/2]

ActivationLayerInfo ( ActivationFunction  f,
float  a = 0.0f,
float  b = 0.0f 
)
inline

Default Constructor.

Parameters
[in]fThe activation function to use.
[in]a(Optional) The alpha parameter used by some activation functions (ActivationFunction::BOUNDED_RELU, ActivationFunction::LU_BOUNDED_RELU, ActivationFunction::LINEAR, ActivationFunction::TANH).
[in]b(Optional) The beta parameter used by some activation functions (ActivationFunction::LINEAR, ActivationFunction::LU_BOUNDED_RELU, ActivationFunction::TANH).

Definition at line 1644 of file Types.h.

1645  : _act(f), _a(a), _b(b), _enabled(true)
1646  {
1647  }
float a() const
Get the alpha value.
Definition: Types.h:1654
float b() const
Get the beta value.
Definition: Types.h:1659

Member Function Documentation

◆ a()

float a ( ) const
inline

Get the alpha value.

Definition at line 1654 of file Types.h.

1655  {
1656  return _a;
1657  }

Referenced by CLGEMMMatrixMultiplyKernel::configure(), and arm_compute::utils::info_helpers::is_relu6().

◆ activation()

◆ b()

float b ( ) const
inline

Get the beta value.

Definition at line 1659 of file Types.h.

1660  {
1661  return _b;
1662  }

Referenced by CLGEMMMatrixMultiplyKernel::configure(), and arm_compute::utils::info_helpers::is_relu6().

◆ enabled()


The documentation for this class was generated from the following file: