athena__activation_tanh Module

Module containing implementation of the tanh activation function

This module implements the hyperbolic tangent activation that squashes inputs to the range (-1, 1), zero-centered unlike sigmoid.

Mathematical operation:

Derivative:

Properties: Smooth, bounded , zero-centered, saturates for large Preferred over sigmoid in many cases due to zero-centering


Uses


Interfaces

public interface tanh_actv_type

  • private function initialise(scale, attributes) result(activation)

    Initialise a tanh activation function

    Arguments

    Type IntentOptional Attributes Name
    real(kind=real32), intent(in), optional :: scale

    Optional scale factor for activation output
    type(onnx_attribute_type), intent(in), optional, dimension(:) :: attributes

    Optional array of ONNX attributes

    Return Value type(tanh_actv_type)

    tanh activation type


Derived Types

type, public, extends(base_actv_type) ::  tanh_actv_type

Type for tanh activation function with overloaded procedures

Components

Type Visibility Attributes Name Initial
logical, public :: apply_scaling = .false.

Boolean to apply scaling or not
character(len=10), public :: name

Name of the activation function
real(kind=real32), public :: scale = 1._real32

Scale of the activation function
real(kind=real32), public :: threshold

Threshold of the activation function

Constructor

private function initialise (scale, attributes)

Initialise a tanh activation function

Type-Bound Procedures

procedure, public, pass(this) :: apply => apply_tanh
procedure, public, pass(this) :: apply_attributes => apply_attributes_tanh
procedure, public, pass(this) :: export_attributes => export_attributes_tanh
procedure, public, pass(this) :: print_to_unit => print_to_unit_actv
procedure, public, pass(this) :: reset => reset_tanh

Functions

public function create_from_onnx_tanh_activation(attributes) result(activation)

Create tanh activation function from ONNX attributes

Arguments

Type IntentOptional Attributes Name
type(onnx_attribute_type), intent(in), dimension(:) :: attributes

Array of ONNX attributes

Return Value class(base_actv_type), allocatable

Instance of activation type

private function apply_tanh(this, val) result(output)

Apply tanh activation to 1D array

Read more…

Arguments

Type IntentOptional Attributes Name
class(tanh_actv_type), intent(in) :: this

Tanh activation type
type(array_type), intent(in) :: val

Input values

Return Value type(array_type), pointer

Activated output values

private pure function export_attributes_tanh(this) result(attributes)

Export tanh activation function attributes as ONNX attributes

Arguments

Type IntentOptional Attributes Name
class(tanh_actv_type), intent(in) :: this

Tanh activation type

Return Value type(onnx_attribute_type), allocatable, dimension(:)

Array of ONNX attributes

private function initialise(scale, attributes) result(activation)

Initialise a tanh activation function

Arguments

Type IntentOptional Attributes Name
real(kind=real32), intent(in), optional :: scale

Optional scale factor for activation output
type(onnx_attribute_type), intent(in), optional, dimension(:) :: attributes

Optional array of ONNX attributes

Return Value type(tanh_actv_type)

tanh activation type


Subroutines

private subroutine apply_attributes_tanh(this, attributes)

Load ONNX attributes into tanh activation function

Arguments

Type IntentOptional Attributes Name
class(tanh_actv_type), intent(inout) :: this

Tanh activation type
type(onnx_attribute_type), intent(in), dimension(:) :: attributes

Array of ONNX attributes

private pure subroutine reset_tanh(this)

Reset tanh activation function attributes and variables

Arguments

Type IntentOptional Attributes Name
class(tanh_actv_type), intent(inout) :: this

Tanh activation type