org.deeplearning4j.nn.conf.layers

Class Subsampling3DLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.Subsampling3DLayer

All Implemented Interfaces:

Serializable, Cloneable

public class Subsampling3DLayer
extends Layer

3D subsampling / pooling layer for convolutional neural networks

Supports max and average pooling modes

Author:

Max Pumperla

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ConvolutionMode	convolutionMode
protected boolean	cudnnAllowFallback
protected int[]	kernelSize
protected int[]	padding
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	Subsampling3DLayer(Subsampling3DLayer.BaseSubsamplingBuilder builder)

Method Summary

Modifier and Type	Method and Description
Subsampling3DLayer	clone()
double	getL1ByParam(String paramName) Get the L1 coefficient for the given parameter.
double	getL2ByParam(String paramName) Get the L2 coefficient for the given parameter.
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
ParamInitializer	initializer()
Layer	instantiate(NeuralNetConfiguration conf, Collection<TrainingListener> iterationListeners, int layerIndex, org.nd4j.linalg.api.ndarray.INDArray layerParamsView, boolean initializeParams)
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.Layer

getUpdaterByParam, initializeConstraints, resetLayerDefaultConfig

Methods inherited from class java.lang.Object

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

Field Detail

convolutionMode

protected ConvolutionMode convolutionMode

poolingType

protected PoolingType poolingType

kernelSize

protected int[] kernelSize

stride

protected int[] stride

padding

protected int[] padding

cudnnAllowFallback

protected boolean cudnnAllowFallback

Constructor Detail

Subsampling3DLayer

protected Subsampling3DLayer(Subsampling3DLayer.BaseSubsamplingBuilder builder)

Method Detail

clone

public Subsampling3DLayer clone()

Overrides:

clone in class Layer

instantiate

public Layer instantiate(NeuralNetConfiguration conf,
                         Collection<TrainingListener> iterationListeners,
                         int layerIndex,
                         org.nd4j.linalg.api.ndarray.INDArray layerParamsView,
                         boolean initializeParams)

Specified by:

instantiate in class Layer

initializer

public ParamInitializer initializer()

Specified by:

initializer in class Layer

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

Specified by:

setNIn in class Layer

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

getL1ByParam

public double getL1ByParam(String paramName)

Description copied from class: Layer

Get the L1 coefficient for the given parameter. Different parameters may have different L1 values, even for a single .l1(x) configuration. For example, biases generally aren't L1 regularized, even if weights are

Specified by:

getL1ByParam in class Layer

Parameters:

paramName - Parameter name

Returns:

L1 value for that parameter

getL2ByParam

public double getL2ByParam(String paramName)

Description copied from class: Layer

Get the L2 coefficient for the given parameter. Different parameters may have different L2 values, even for a single .l2(x) configuration. For example, biases generally aren't L1 regularized, even if weights are

Specified by:

getL2ByParam in class Layer

Parameters:

paramName - Parameter name

Returns:

L2 value for that 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 class Layer

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