org.deeplearning4j.nn.conf.preprocessor

Class Cnn3DToFeedForwardPreProcessor

java.lang.Object

org.deeplearning4j.nn.conf.preprocessor.Cnn3DToFeedForwardPreProcessor

All Implemented Interfaces:

Serializable, Cloneable, InputPreProcessor

public class Cnn3DToFeedForwardPreProcessor
extends Object
implements InputPreProcessor

A preprocessor to allow CNN and standard feed-forward network layers to be used together.
For example, CNN3D -> Denselayer
This does two things:
(b) Reshapes 5d activations out of CNN layer, with shape [numExamples, numChannels, inputDepth, inputHeight, inputWidth]) into 2d activations (with shape [numExamples, inputDepth*inputHeight*inputWidth*numChannels]) for use in feed forward layer (a) Reshapes epsilons (weights*deltas) out of FeedFoward layer (which is 2D or 3D with shape [numExamples, inputDepth* inputHeight*inputWidth*numChannels]) into 5d epsilons (with shape [numExamples, numChannels, inputDepth, inputHeight, inputWidth]) suitable to feed into CNN layers.
Note: numChannels is equivalent to featureMaps referenced in different literature

Author:

Max Pumperla

See Also:

for opposite case (i.e., DenseLayer -> CNN3D), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	inputDepth
protected int	inputHeight
protected int	inputWidth
protected boolean	isNCDHW
protected int	numChannels

Constructor Summary

Constructors

Constructor and Description
Cnn3DToFeedForwardPreProcessor()
Cnn3DToFeedForwardPreProcessor(int inputDepth, int inputHeight, int inputWidth)
Cnn3DToFeedForwardPreProcessor(int inputDepth, int inputHeight, int inputWidth, int numChannels, boolean isNCDHW)

Method Summary

Modifier and Type	Method and Description
org.nd4j.linalg.api.ndarray.INDArray	backprop(org.nd4j.linalg.api.ndarray.INDArray epsilons, int miniBatchSize, LayerWorkspaceMgr workspaceMgr) Reverse the preProcess during backprop.
Cnn3DToFeedForwardPreProcessor	clone()
org.nd4j.linalg.primitives.Pair<org.nd4j.linalg.api.ndarray.INDArray,MaskState>	feedForwardMaskArray(org.nd4j.linalg.api.ndarray.INDArray maskArray, MaskState currentMaskState, int minibatchSize)
InputType	getOutputType(InputType inputType) For a given type of input to this preprocessor, what is the type of the output?
org.nd4j.linalg.api.ndarray.INDArray	preProcess(org.nd4j.linalg.api.ndarray.INDArray input, int miniBatchSize, LayerWorkspaceMgr workspaceMgr) Pre preProcess input/activations for a multi layer network

Methods inherited from class java.lang.Object

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

Field Detail

inputDepth

protected int inputDepth

inputHeight

protected int inputHeight

inputWidth

protected int inputWidth

numChannels

protected int numChannels

isNCDHW

protected boolean isNCDHW

Constructor Detail

Cnn3DToFeedForwardPreProcessor

public Cnn3DToFeedForwardPreProcessor(int inputDepth,
                                      int inputHeight,
                                      int inputWidth,
                                      int numChannels,
                                      boolean isNCDHW)

Parameters:

inputDepth - input channels

inputHeight - input height

inputWidth - input width

numChannels - input channels

isNCDHW - boolean to indicate data format, i.e. channels first (NCDHW) vs. channels last (NDHWC)

Cnn3DToFeedForwardPreProcessor

public Cnn3DToFeedForwardPreProcessor(int inputDepth,
                                      int inputHeight,
                                      int inputWidth)

Cnn3DToFeedForwardPreProcessor

public Cnn3DToFeedForwardPreProcessor()

Method Detail

preProcess

public org.nd4j.linalg.api.ndarray.INDArray preProcess(org.nd4j.linalg.api.ndarray.INDArray input,
                                                       int miniBatchSize,
                                                       LayerWorkspaceMgr workspaceMgr)

Description copied from interface: InputPreProcessor

Pre preProcess input/activations for a multi layer network

Specified by:

preProcess in interface InputPreProcessor

Parameters:

input - the input to pre preProcess

miniBatchSize - Minibatch size

workspaceMgr - Workspace manager

Returns:

the processed input. Note that the returned array should be placed in the ArrayType.ACTIVATIONS workspace via the workspace manager

backprop

public org.nd4j.linalg.api.ndarray.INDArray backprop(org.nd4j.linalg.api.ndarray.INDArray epsilons,
                                                     int miniBatchSize,
                                                     LayerWorkspaceMgr workspaceMgr)

Description copied from interface: InputPreProcessor

Reverse the preProcess during backprop. Process Gradient/epsilons before passing them to the layer below.

Specified by:

backprop in interface InputPreProcessor

Parameters:

epsilons - which is a pair of the gradient and epsilon

miniBatchSize - Minibatch size

workspaceMgr - Workspace manager

Returns:

the reverse of the pre preProcess step (if any). Note that the returned array should be placed in ArrayType.ACTIVATION_GRAD workspace via the workspace manager

clone

public Cnn3DToFeedForwardPreProcessor clone()

Specified by:

clone in interface InputPreProcessor

Overrides:

clone in class Object

getOutputType

public InputType getOutputType(InputType inputType)

Description copied from interface: InputPreProcessor

For a given type of input to this preprocessor, what is the type of the output?

Specified by:

getOutputType in interface InputPreProcessor

Parameters:

inputType - Type of input for the preprocessor

Returns:

Type of input after applying the preprocessor

feedForwardMaskArray

public org.nd4j.linalg.primitives.Pair<org.nd4j.linalg.api.ndarray.INDArray,MaskState> feedForwardMaskArray(org.nd4j.linalg.api.ndarray.INDArray maskArray,
                                                                                                            MaskState currentMaskState,
                                                                                                            int minibatchSize)

Specified by:

feedForwardMaskArray in interface InputPreProcessor