learning_rate_function_base_utilities Module

This module defines an abstract class to define learning rate functions

Uses

- precision_utilities
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Abstract Interfaces

abstract interface

public function learning_rate_calculate(learning_rate_fn, iteration) result(alpha)

Template for a function that calculates the learning rate Import section

Arguments

Type	Intent	Optional	Attributes		Name
class(learning_rate_function_base)				::	learning_rate_fn	An `learning_rate_function_base` object
real(kind=wp),	intent(inout)			::	iteration	A real variable with the current iteration

Return Value real(kind=wp)

A real variable with the learning rate

abstract interface

public subroutine learning_rate_set_parameters(learning_rate_fn, lambda0, tau)

Template for a function to define the parameters of the learning rate function

Arguments

Type	Intent	Optional	Attributes		Name
class(learning_rate_function_base)				::	learning_rate_fn
real(kind=wp)				::	lambda0
real(kind=wp)				::	tau

Derived Types

type, public, abstract :: learning_rate_function_base

Abstract class used to derive classes that calculates the learning rate

Type-Bound Procedures

procedure(learning_rate_set_parameters), public, deferred :: set_parameters
procedure(learning_rate_calculate), public, deferred :: calculate