Package org.deeplearning4j.nn.gradient

Class DefaultGradient

java.lang.Object

org.deeplearning4j.nn.gradient.DefaultGradient

All Implemented Interfaces:

Serializable, Gradient

public class DefaultGradient
extends Object
implements Gradient

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static char	DEFAULT_FLATTENING_ORDER

Constructor Summary

Constructors

Constructor	Description
DefaultGradient()
DefaultGradient(INDArray flattenedGradient)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear residual parameters (useful for returning a gradient and then clearing old objects)
Character	flatteningOrderForVariable(String variable)	Return the gradient flattening order for the specified variable, or null if it is not explicitly set
INDArray	getGradientFor(String variable)	The gradient for the given variable
INDArray	gradient()	The full gradient as one flat vector
INDArray	gradient(List<String> order)	The full gradient as one flat vector
Map<String,INDArray>	gradientForVariable()	Gradient look up table
INDArray	setGradientFor(String variable, INDArray newGradient)	Update gradient for the given variable
INDArray	setGradientFor(String variable, INDArray gradient, Character flatteningOrder)	Update gradient for the given variable; also (optionally) specify the order in which the array should be flattened to a row vector
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FLATTENING_ORDER

public static final char DEFAULT_FLATTENING_ORDER

See Also:

Constant Field Values

Constructor Detail

DefaultGradient

public DefaultGradient()

DefaultGradient

public DefaultGradient(INDArray flattenedGradient)

Method Detail

gradientForVariable

public Map<String,INDArray> gradientForVariable()

Description copied from interface: Gradient

Gradient look up table

Specified by:

gradientForVariable in interface Gradient

Returns:

the gradient look up table

gradient

public INDArray gradient(List<String> order)

Description copied from interface: Gradient

The full gradient as one flat vector

Specified by:

gradient in interface Gradient

Returns:

gradient

public INDArray gradient()

Description copied from interface: Gradient

The full gradient as one flat vector

Specified by:

gradient in interface Gradient

Returns:

clear

public void clear()

Description copied from interface: Gradient

Clear residual parameters (useful for returning a gradient and then clearing old objects)

Specified by:

clear in interface Gradient

getGradientFor

public INDArray getGradientFor(String variable)

Description copied from interface: Gradient

The gradient for the given variable

Specified by:

getGradientFor in interface Gradient

Parameters:

variable - the variable to get the gradient for

Returns:

the gradient for the given variable or null

setGradientFor

public INDArray setGradientFor(String variable,
                               INDArray newGradient)

Description copied from interface: Gradient

Update gradient for the given variable

Specified by:

setGradientFor in interface Gradient

Parameters:

variable - the variable to get the gradient for

newGradient - the gradient values

Returns:

the gradient for the given variable or null

setGradientFor

public INDArray setGradientFor(String variable,
                               INDArray gradient,
                               Character flatteningOrder)

Description copied from interface: Gradient

Update gradient for the given variable; also (optionally) specify the order in which the array should be flattened to a row vector

Specified by:

setGradientFor in interface Gradient

Parameters:

variable - the variable to get the gradient for

gradient - the gradient values

flatteningOrder - the order in which gradients should be flattened (null ok - default)

Returns:

the gradient for the given variable or null

flatteningOrderForVariable

public Character flatteningOrderForVariable(String variable)

Description copied from interface: Gradient

Return the gradient flattening order for the specified variable, or null if it is not explicitly set

Specified by:

flatteningOrderForVariable in interface Gradient

Parameters:

variable - Variable to return the gradient flattening order for

Returns:

Order in which the specified variable's gradient should be flattened

toString

public String toString()

Overrides:

toString in class Object