org.deeplearning4j.nn.layers.normalization

Class BatchNormalization

java.lang.Object

org.deeplearning4j.nn.layers.AbstractLayer<LayerConfT>

org.deeplearning4j.nn.layers.BaseLayer<BatchNormalization>

org.deeplearning4j.nn.layers.normalization.BatchNormalization

All Implemented Interfaces:

Serializable, Cloneable, Layer, Model

public class BatchNormalization
extends BaseLayer<BatchNormalization>

Batch normalization layer. Rerences: http://arxiv.org/pdf/1502.03167v3.pdf http://arxiv.org/pdf/1410.7455v8.pdf https://kratzert.github.io/2016/02/12/understanding-the-gradient-flow-through-the-batch-normalization-layer.html tried this approach but results did not match https://cthorey.github.io/backpropagation/ ideal to apply this between linear and non-linear transformations in layers it follows

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.deeplearning4j.nn.api.Layer

Layer.TrainingMode, Layer.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index
protected List<TrainingListener>	listeners
protected org.nd4j.linalg.api.ndarray.INDArray	std
protected org.nd4j.linalg.api.ndarray.INDArray	xHat
protected org.nd4j.linalg.api.ndarray.INDArray	xMu

Fields inherited from class org.deeplearning4j.nn.layers.BaseLayer

gradient, gradientsFlattened, gradientViews, optimizer, params, paramsFlattened, score, solver, weightNoiseParams

Fields inherited from class org.deeplearning4j.nn.layers.AbstractLayer

cacheMode, conf, dropoutApplied, dropoutMask, epochCount, input, iterationCount, maskArray, maskState, preOutput, trainingListeners

Constructor Summary

Constructors

Constructor and Description
BatchNormalization(NeuralNetConfiguration conf)

Method Summary

Modifier and Type	Method and Description
org.nd4j.linalg.api.ndarray.INDArray	activate(boolean training, LayerWorkspaceMgr workspaceMgr) Perform forward pass and return the activations array with the last set input
org.nd4j.linalg.primitives.Pair<Gradient,org.nd4j.linalg.api.ndarray.INDArray>	backpropGradient(org.nd4j.linalg.api.ndarray.INDArray epsilon, LayerWorkspaceMgr workspaceMgr) Calculate the gradient relative to the error in the next layer
double	calcL1(boolean backpropParamsOnly) Calculate the l1 regularization term 0.0 if regularization is not used.
double	calcL2(boolean backpropParamsOnly) Calculate the l2 regularization term 0.0 if regularization is not used.
Layer	clone() Clone the layer
void	fit(org.nd4j.linalg.api.ndarray.INDArray input, LayerWorkspaceMgr workspaceMgr) Fit the model to the given data
int	getIndex() Get the layer index.
Collection<TrainingListener>	getListeners() Get the iteration listeners for this layer.
int[]	getShape(org.nd4j.linalg.api.ndarray.INDArray x)
Gradient	gradient() Get the gradient.
boolean	isPretrainLayer() Returns true if the layer can be trained in an unsupervised/pretrain manner (AE, VAE, etc)
org.nd4j.linalg.api.ndarray.INDArray	preOutput(org.nd4j.linalg.api.ndarray.INDArray x, Layer.TrainingMode training, LayerWorkspaceMgr workspaceMgr)
void	setIndex(int index) Set the layer index.
void	setListeners(TrainingListener... listeners) Set the iteration listeners for this layer.
Layer	transpose() Return a transposed copy of the weights/bias (this means reverse the number of inputs and outputs on the weights)
Layer.Type	type() Returns the layer type

Methods inherited from class org.deeplearning4j.nn.layers.BaseLayer

accumulateScore, clear, clearNoiseWeightParams, computeGradientAndScore, fit, getGradientsViewArray, getOptimizer, getParam, getParamWithNoise, hasBias, initParams, layerConf, numParams, params, paramTable, paramTable, preOutput, score, setBackpropGradientsViewArray, setParam, setParams, setParams, setParamsViewArray, setParamTable, setScoreWithZ, toString, update, update

Methods inherited from class org.deeplearning4j.nn.layers.AbstractLayer

activate, addListeners, applyConstraints, applyDropOutIfNecessary, applyMask, assertInputSet, batchSize, conf, feedForwardMaskArray, getInput, getInputMiniBatchSize, getMaskArray, gradientAndScore, init, input, layerId, numParams, setCacheMode, setConf, setInput, setInputMiniBatchSize, setListeners, setMaskArray, validateInput

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deeplearning4j.nn.api.Layer

getEpochCount, getIterationCount, setEpochCount, setIterationCount

Field Detail

index

protected int index

listeners

protected List<TrainingListener> listeners

std

protected org.nd4j.linalg.api.ndarray.INDArray std

xMu

protected org.nd4j.linalg.api.ndarray.INDArray xMu

xHat

protected org.nd4j.linalg.api.ndarray.INDArray xHat

Constructor Detail

BatchNormalization

public BatchNormalization(NeuralNetConfiguration conf)

Method Detail

calcL2

public double calcL2(boolean backpropParamsOnly)

Description copied from interface: Layer

Calculate the l2 regularization term
0.0 if regularization is not used. Or 0.5 * l2Coeff * l2Magnitude otherwise.
Note that this does not divide by mini-batch size

Specified by:

calcL2 in interface Layer

Overrides:

calcL2 in class BaseLayer<BatchNormalization>

Parameters:

backpropParamsOnly - If true: calculate L2 based on backprop params only. If false: calculate based on all params (including pretrain params, if any)

Returns:

the l2 regularization term for this layer.

calcL1

public double calcL1(boolean backpropParamsOnly)

Description copied from interface: Layer

Calculate the l1 regularization term
0.0 if regularization is not used. Or l1Coeff * l1Magnitude otherwise.
Note that this does not divide by mini-batch size

Specified by:

calcL1 in interface Layer

Overrides:

calcL1 in class BaseLayer<BatchNormalization>

Parameters:

backpropParamsOnly - If true: calculate L1 based on backprop params only. If false: calculate based on all params (including pretrain params, if any)

Returns:

the l1 regularization term for this layer.

type

public Layer.Type type()

Description copied from interface: Layer

Returns the layer type

Specified by:

type in interface Layer

Overrides:

type in class AbstractLayer<BatchNormalization>

Returns:

backpropGradient

public org.nd4j.linalg.primitives.Pair<Gradient,org.nd4j.linalg.api.ndarray.INDArray> backpropGradient(org.nd4j.linalg.api.ndarray.INDArray epsilon,
                                                                                                       LayerWorkspaceMgr workspaceMgr)

Description copied from interface: Layer

Calculate the gradient relative to the error in the next layer

Specified by:

backpropGradient in interface Layer

Overrides:

backpropGradient in class BaseLayer<BatchNormalization>

Parameters:

epsilon - w^(L+1)*delta^(L+1). Or, equiv: dC/da, i.e., (dC/dz)*(dz/da) = dC/da, where C is cost function a=sigma(z) is activation.

workspaceMgr - Workspace manager

Returns:

Pair where Gradient is gradient for this layer, INDArray is epsilon (activation gradient) needed by next layer, but before element-wise multiply by sigmaPrime(z). So for standard feed-forward layer, if this layer is L, then return.getSecond() == dL/dIn = (w^(L)*(delta^(L))^T)^T. Note that the returned array should be placed in the ArrayType.ACTIVATION_GRAD workspace via the workspace manager

fit

public void fit(org.nd4j.linalg.api.ndarray.INDArray input,
                LayerWorkspaceMgr workspaceMgr)

Description copied from interface: Model

Fit the model to the given data

Specified by:

fit in interface Model

Overrides:

fit in class BaseLayer<BatchNormalization>

Parameters:

input - the data to fit the model to

activate

public org.nd4j.linalg.api.ndarray.INDArray activate(boolean training,
                                                     LayerWorkspaceMgr workspaceMgr)

Description copied from interface: Layer

Perform forward pass and return the activations array with the last set input

Specified by:

activate in interface Layer

Overrides:

activate in class BaseLayer<BatchNormalization>

Parameters:

training - training or test mode

workspaceMgr - Workspace manager

Returns:

the activation (layer output) of the last specified input. Note that the returned array should be placed in the ArrayType.ACTIVATIONS workspace via the workspace manager

gradient

public Gradient gradient()

Description copied from interface: Model

Get the gradient. Note that this method will not calculate the gradient, it will rather return the gradient that has been computed before. For calculating the gradient, see Model#computeGradientAndScore() .

Specified by:

gradient in interface Model

Overrides:

gradient in class BaseLayer<BatchNormalization>

Returns:

the gradient for this model, as calculated before

preOutput

public org.nd4j.linalg.api.ndarray.INDArray preOutput(org.nd4j.linalg.api.ndarray.INDArray x,
                                                      Layer.TrainingMode training,
                                                      LayerWorkspaceMgr workspaceMgr)

transpose

public Layer transpose()

Description copied from interface: Layer

Return a transposed copy of the weights/bias (this means reverse the number of inputs and outputs on the weights)

Specified by:

transpose in interface Layer

Overrides:

transpose in class BaseLayer<BatchNormalization>

Returns:

the transposed layer

clone

public Layer clone()

Description copied from interface: Layer

Clone the layer

Specified by:

clone in interface Layer

Overrides:

clone in class BaseLayer<BatchNormalization>

Returns:

getListeners

public Collection<TrainingListener> getListeners()

Description copied from interface: Layer

Get the iteration listeners for this layer.

Specified by:

getListeners in interface Layer

Overrides:

getListeners in class AbstractLayer<BatchNormalization>

setListeners

public void setListeners(TrainingListener... listeners)

Description copied from interface: Layer

Set the iteration listeners for this layer.

Specified by:

setListeners in interface Layer

Specified by:

setListeners in interface Model

Overrides:

setListeners in class AbstractLayer<BatchNormalization>

setIndex

public void setIndex(int index)

Description copied from interface: Layer

Set the layer index.

Specified by:

setIndex in interface Layer

Overrides:

setIndex in class AbstractLayer<BatchNormalization>

getIndex

public int getIndex()

Description copied from interface: Layer

Get the layer index.

Specified by:

getIndex in interface Layer

Overrides:

getIndex in class AbstractLayer<BatchNormalization>

isPretrainLayer

public boolean isPretrainLayer()

Description copied from interface: Layer

Returns true if the layer can be trained in an unsupervised/pretrain manner (AE, VAE, etc)

Returns:

true if the layer can be pretrained (using fit(INDArray), false otherwise

getShape

public int[] getShape(org.nd4j.linalg.api.ndarray.INDArray x)