org.nd4j.linalg.learning

Class Adam

java.lang.Object

org.nd4j.linalg.learning.Adam

All Implemented Interfaces:

Serializable, GradientUpdater

public class Adam
extends Object
implements Serializable, GradientUpdater

The Adam updater. http://arxiv.org/abs/1412.6980

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Adam.AdamAggregator

Constructor Summary

Constructors

Constructor and Description
Adam(double alpha)
Adam(double alpha, double beta1, double beta2)
Adam(double alpha, double beta1, double beta2, double epsilon)

Method Summary

Modifier and Type	Method and Description
GradientUpdaterAggregator	getAggregator(boolean addThis) Get a GradientUpdaterAggregator.
INDArray	getGradient(INDArray gradient, int iteration) Calculate the update based on the given gradient
void	update(Object... args) update(learningRate,momentum)

Methods inherited from class java.lang.Object

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

Constructor Detail

Adam

public Adam(double alpha,
            double beta1,
            double beta2,
            double epsilon)

Adam

public Adam(double alpha,
            double beta1,
            double beta2)

Adam

public Adam(double alpha)

Method Detail

update

public void update(Object... args)

Description copied from interface: GradientUpdater

update(learningRate,momentum)

Specified by:

update in interface GradientUpdater

getGradient

public INDArray getGradient(INDArray gradient,
                            int iteration)

Calculate the update based on the given gradient

Specified by:

getGradient in interface GradientUpdater

Parameters:

gradient - the gradient to get the update for

iteration -

Returns:

the gradient

getAggregator

public GradientUpdaterAggregator getAggregator(boolean addThis)

Description copied from interface: GradientUpdater

Get a GradientUpdaterAggregator. The aggregator is used (typically in distributed learning scenarios) to combine separate GradientUpdater instances for different networks (usually by averaging).

Specified by:

getAggregator in interface GradientUpdater

Parameters:

addThis - If true: return a GradientUpdaterAggregator with the GradientUpdater already added. If false: return an empty (uninitialized) GradientUpdaterAggregator