org.deeplearning4j.nn.conf.constraint

Class MinMaxNormConstraint

java.lang.Object

org.deeplearning4j.nn.conf.constraint.BaseConstraint

org.deeplearning4j.nn.conf.constraint.MinMaxNormConstraint

All Implemented Interfaces:

Serializable, Cloneable, LayerConstraint

public class MinMaxNormConstraint
extends BaseConstraint

Constrain the minimum AND maximum L2 norm of the incoming weights for each unit to be between the specified values. If the L2 norm exceeds the specified max value, the weights will be scaled down to satisfy the constraint; if the L2 norm is less than the specified min value, the weights will be scaled up
Note that this constraint supports a rate parameter (default: 1.0, which is equivalent to a strict constraint). If rate < 1.0, the applied norm2 constraint will be (1-rate)*norm2 + rate*clippedNorm2, where clippedNorm2 is the norm2 value after applying clipping to min/max values.

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_RATE

Fields inherited from class org.deeplearning4j.nn.conf.constraint.BaseConstraint

DEFAULT_EPSILON, dimensions, epsilon, params

Constructor Summary

Constructors

Constructor and Description
MinMaxNormConstraint(double min, double max, double rate, int... dimensions) Apply to weights but not biases by default
MinMaxNormConstraint(double min, double max, double rate, Set<String> paramNames, int... dimensions)
MinMaxNormConstraint(double min, double max, int... dimensions) Apply to weights but not biases by default

Method Summary

Modifier and Type	Method and Description
void	apply(org.nd4j.linalg.api.ndarray.INDArray param)
MinMaxNormConstraint	clone()

Methods inherited from class org.deeplearning4j.nn.conf.constraint.BaseConstraint

applyConstraint, getBroadcastDims

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deeplearning4j.nn.api.layers.LayerConstraint

getParams, setParams

Field Detail

DEFAULT_RATE

public static final double DEFAULT_RATE

See Also:

Constant Field Values

Constructor Detail

MinMaxNormConstraint

public MinMaxNormConstraint(double min,
                            double max,
                            int... dimensions)

Apply to weights but not biases by default

Parameters:

max - Maximum L2 value

min - Minimum L2 value

dimensions - Dimensions to apply to. For DenseLayer, OutputLayer, RnnOutputLayer, LSTM, etc: this should be dimension 1. For CNNs, this should be dimensions [1,2,3] corresponding to last 3 of parameters which have order [depthOut, depthIn, kH, kW]

MinMaxNormConstraint

public MinMaxNormConstraint(double min,
                            double max,
                            double rate,
                            int... dimensions)

Apply to weights but not biases by default

Parameters:

max - Maximum L2 value

min - Minimum L2 value

rate - Constraint rate

dimensions - Dimensions to apply to. For DenseLayer, OutputLayer, RnnOutputLayer, LSTM, etc: this should be dimension 1. For CNNs, this should be dimensions [1,2,3] corresponding to last 3 of parameters which have order [depthOut, depthIn, kH, kW]

MinMaxNormConstraint

public MinMaxNormConstraint(double min,
                            double max,
                            double rate,
                            Set<String> paramNames,
                            int... dimensions)

Parameters:

max - Maximum L2 value

min - Minimum L2 value

rate - Constraint rate

paramNames - Which parameter names to apply constraint to

dimensions - Dimensions to apply to. For DenseLayer, OutputLayer, RnnOutputLayer, LSTM, etc: this should be dimension 1. For CNNs, this should be dimensions [1,2,3] corresponding to last 3 of parameters which have order [depthOut, depthIn, kH, kW]

Method Detail

apply

public void apply(org.nd4j.linalg.api.ndarray.INDArray param)

Specified by:

apply in class BaseConstraint

clone

public MinMaxNormConstraint clone()

Specified by:

clone in interface LayerConstraint

Specified by:

clone in class BaseConstraint