org.deeplearning4j.nn.conf.layers.util

Class MaskLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.NoParamLayer

org.deeplearning4j.nn.conf.layers.util.MaskLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

public class MaskLayer
extends NoParamLayer

MaskLayer applies the mask array to the forward pass activations, and backward pass gradients, passing through this layer. It can be used with 2d (feed-forward), 3d (time series) or 4d (CNN) activations.

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.deeplearning4j.nn.conf.layers.Layer

Layer.Builder<T extends Layer.Builder<T>>

Field Summary

Fields inherited from class org.deeplearning4j.nn.conf.layers.Layer

constraints, iDropout, layerName

Constructor Summary

Constructors

Constructor and Description
MaskLayer()

Method Summary

Modifier and Type	Method and Description
LayerMemoryReport	getMemoryReport(InputType inputType) This is a report of the estimated memory consumption for the given layer
InputType	getOutputType(int layerIndex, InputType inputType) For a given type of input to this layer, what is the type of the output?
InputPreProcessor	getPreProcessorForInputType(InputType inputType) For the given type of input to this layer, what preprocessor (if any) is required? Returns null if no preprocessor is required, otherwise returns an appropriate InputPreProcessor for this layer, such as a CnnToFeedForwardPreProcessor
List<Regularization>	getRegularizationByParam(String paramName) Get the regularization types (l1/l2/weight decay) for the given parameter.
ParamInitializer	initializer()
Layer	instantiate(NeuralNetConfiguration conf, Collection<TrainingListener> trainingListeners, int layerIndex, INDArray layerParamsView, boolean initializeParams, DataType networkDataType)
boolean	isPretrainParam(String paramName) Is the specified parameter a layerwise pretraining only parameter? For example, visible bias params in an autoencoder (or, decoder params in a variational autoencoder) aren't used during supervised backprop. Layers (like DenseLayer, etc) with no pretrainable parameters will return false for all (valid) inputs.
void	setNIn(InputType inputType, boolean override) Set the nIn value (number of inputs, or input channels for CNNs) based on the given input type
String	toString()

Methods inherited from class org.deeplearning4j.nn.conf.layers.NoParamLayer

getGradientNormalization, getGradientNormalizationThreshold

Methods inherited from class org.deeplearning4j.nn.conf.layers.Layer

clone, getUpdaterByParam, initializeConstraints, resetLayerDefaultConfig, setDataType

Methods inherited from class java.lang.Object

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

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

getLayerName

Constructor Detail

MaskLayer

public MaskLayer()

Method Detail

instantiate

public Layer instantiate(NeuralNetConfiguration conf,
                         Collection<TrainingListener> trainingListeners,
                         int layerIndex,
                         INDArray layerParamsView,
                         boolean initializeParams,
                         DataType networkDataType)

Specified by:

instantiate in class Layer

initializer

public ParamInitializer initializer()

Overrides:

initializer in class NoParamLayer

Returns:

The parameter initializer for this model

getOutputType

public InputType getOutputType(int layerIndex,
                               InputType inputType)

Description copied from class: Layer

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

Specified by:

getOutputType in class Layer

Parameters:

layerIndex - Index of the layer

inputType - Type of input for the layer

Returns:

Type of output from the layer

setNIn

public void setNIn(InputType inputType,
                   boolean override)

Description copied from class: Layer

Set the nIn value (number of inputs, or input channels for CNNs) based on the given input type

Overrides:

setNIn in class NoParamLayer

Parameters:

inputType - Input type for this layer

override - If false: only set the nIn value if it's not already set. If true: set it regardless of whether it's already set or not.

getPreProcessorForInputType

public InputPreProcessor getPreProcessorForInputType(InputType inputType)

Description copied from class: Layer

For the given type of input to this layer, what preprocessor (if any) is required?
Returns null if no preprocessor is required, otherwise returns an appropriate InputPreProcessor for this layer, such as a CnnToFeedForwardPreProcessor

Specified by:

getPreProcessorForInputType in class Layer

Parameters:

inputType - InputType to this layer

Returns:

Null if no preprocessor is required, otherwise the type of preprocessor necessary for this layer/input combination

getRegularizationByParam

public List<Regularization> getRegularizationByParam(String paramName)

Description copied from class: Layer

Get the regularization types (l1/l2/weight decay) for the given parameter. Different parameters may have different regularization types.

Specified by:

getRegularizationByParam in interface TrainingConfig

Overrides:

getRegularizationByParam in class NoParamLayer

Parameters:

paramName - Parameter name ("W", "b" etc)

Returns:

Regularization types (if any) for the specified parameter

isPretrainParam

public boolean isPretrainParam(String paramName)

Description copied from class: Layer

Is the specified parameter a layerwise pretraining only parameter?
For example, visible bias params in an autoencoder (or, decoder params in a variational autoencoder) aren't used during supervised backprop.
Layers (like DenseLayer, etc) with no pretrainable parameters will return false for all (valid) inputs.

Specified by:

isPretrainParam in interface TrainingConfig

Overrides:

isPretrainParam in class NoParamLayer

Parameters:

paramName - Parameter name/key

Returns:

True if the parameter is for layerwise pretraining only, false otherwise

getMemoryReport

public LayerMemoryReport getMemoryReport(InputType inputType)

Description copied from class: Layer

This is a report of the estimated memory consumption for the given layer

Specified by:

getMemoryReport in class Layer

Parameters:

inputType - Input type to the layer. Memory consumption is often a function of the input type

Returns:

Memory report for the layer

toString

public String toString()

Overrides:

toString in class Object