org.deeplearning4j.nn.conf.layers

Class SubsamplingLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.NoParamLayer

org.deeplearning4j.nn.conf.layers.SubsamplingLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

Direct Known Subclasses:

Pooling2D, Subsampling1DLayer

public class SubsamplingLayer
extends NoParamLayer

Subsampling layer also referred to as pooling in convolution neural nets Supports the following pooling types: MAX, AVG, SUM, PNORM

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SubsamplingLayer.BaseSubsamplingBuilder<T extends SubsamplingLayer.BaseSubsamplingBuilder<T>>
static class	SubsamplingLayer.Builder
static class	SubsamplingLayer.PoolingType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	avgPoolIncludePadInDivisor
protected CNN2DFormat	cnn2dDataFormat
protected ConvolutionMode	convolutionMode
protected boolean	cudnnAllowFallback
protected int[]	dilation
protected double	eps
protected int[]	kernelSize
protected int[]	padding
protected int	pnorm
protected PoolingType	poolingType
protected int[]	stride

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

constraints, iDropout, layerName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubsamplingLayer(SubsamplingLayer.BaseSubsamplingBuilder builder)

Method Summary

Modifier and Type	Method and Description
SubsamplingLayer	clone()
double	getEps()
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?
int	getPnorm()
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
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

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

getGradientNormalization, getGradientNormalizationThreshold, getRegularizationByParam

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

getUpdaterByParam, initializeConstraints, resetLayerDefaultConfig, setDataType

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.TrainingConfig

getLayerName

Field Detail

convolutionMode

protected ConvolutionMode convolutionMode

poolingType

protected PoolingType poolingType

kernelSize

protected int[] kernelSize

stride

protected int[] stride

padding

protected int[] padding

dilation

protected int[] dilation

pnorm

protected int pnorm

eps

protected double eps

cudnnAllowFallback

protected boolean cudnnAllowFallback

cnn2dDataFormat

protected CNN2DFormat cnn2dDataFormat

avgPoolIncludePadInDivisor

protected boolean avgPoolIncludePadInDivisor

Constructor Detail

SubsamplingLayer

protected SubsamplingLayer(SubsamplingLayer.BaseSubsamplingBuilder builder)

Method Detail

clone

public SubsamplingLayer clone()

Overrides:

clone in class Layer

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

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

getPnorm

public int getPnorm()

getEps

public double getEps()