org.nd4j.linalg.learning.config

Class Sgd

java.lang.Object

org.nd4j.linalg.learning.config.Sgd

All Implemented Interfaces:

Serializable, Cloneable, IUpdater

public class Sgd
extends Object
implements IUpdater

SGD updater applies a learning rate only

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sgd.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_SGD_LR

Constructor Summary

Constructors

Constructor and Description
Sgd()

Method Summary

Modifier and Type	Method and Description
void	applySchedules(int iteration, double newLearningRate) Apply the new learning rate and any other schedules
Sgd	clone() Clone the 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.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.learning.config.IUpdater

equals

Field Detail

DEFAULT_SGD_LR

public static final double DEFAULT_SGD_LR

See Also:

Constant Field Values

Constructor Detail

Sgd

public Sgd()

Method Detail

stateSize

public long stateSize(long numParams)

Description copied from interface: IUpdater

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.

Specified by:

stateSize in interface IUpdater

Parameters:

numParams - Number of parameters

Returns:

Updater state size for the given number of parameters

applySchedules

public void applySchedules(int iteration,
                           double newLearningRate)

Description copied from interface: IUpdater

Apply the new learning rate and any other schedules

Specified by:

applySchedules in interface IUpdater

Parameters:

iteration - Current iteration count

newLearningRate - new learning rate to set for the updater

instantiate

public GradientUpdater instantiate(INDArray viewArray,
                                   boolean initializeViewArray)

Description copied from interface: IUpdater

Create a new gradient updater

Specified by:

instantiate in interface IUpdater

Parameters:

viewArray - The updater state size view away

initializeViewArray - If true: initialise the updater state

Returns:

clone

public Sgd clone()

Description copied from interface: IUpdater

Clone the updater

Specified by:

clone in interface IUpdater

Overrides:

clone in class Object