org.nd4j.linalg.learning.config

Interface IUpdater

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AdaDelta, AdaGrad, Adam, AdaMax, Nadam, Nesterovs, NoOp, RmsProp, Sgd

public interface IUpdater
extends Serializable, Cloneable

IUpdater interface: used for configuration and instantiation of updaters - both built-in and custom.
Note that the actual implementations for updaters are in GradientUpdater

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
void	applySchedules(int iteration, double newLearningRate) Apply the new learning rate and any other schedules
IUpdater	clone() Clone the updater
boolean	equals(Object updater)
GradientUpdater	instantiate(INDArray viewArray, boolean initializeViewArray) Create a new gradient updater
long	stateSize(long numParams) Determine the updater state size for the given number of parameters.

Method Detail

stateSize

long stateSize(long numParams)

Determine the updater state size for the given number of parameters. Usually a integer multiple (0,1 or 2) times the number of parameters in a layer.

Parameters:

numParams - Number of parameters

Returns:

Updater state size for the given number of parameters

applySchedules

void applySchedules(int iteration,
                    double newLearningRate)

Apply the new learning rate and any other schedules

Parameters:

iteration - Current iteration count

newLearningRate - new learning rate to set for the updater

instantiate

GradientUpdater instantiate(INDArray viewArray,
                            boolean initializeViewArray)

Create a new gradient updater

Parameters:

viewArray - The updater state size view away

initializeViewArray - If true: initialise the updater state

Returns:

equals

boolean equals(Object updater)

Overrides:

equals in class Object

clone

IUpdater clone()

Clone the updater