org.deeplearning4j.nn.conf.layers

Class SpaceToBatchLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.NoParamLayer

org.deeplearning4j.nn.conf.layers.SpaceToBatchLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

public class SpaceToBatchLayer
extends NoParamLayer

Space to batch utility layer configuration for convolutional input types.

Does a 2-dimensional space to batch operation, i.e. ransforms data from a tensor from 2 spatial dimensions into batch dimension according to the "blocks" specified (a vector of length 2). Afterwards the spatial dimensions are optionally padded, as specified in "padding", a tensor of dim (2, 2), denoting the padding range.

Example:

 input:         [[[[1], [2]], [[3], [4]]]]
 input shape:   [1, 2, 2, 1]
 blocks:        [2, 2]
 padding:       [[0, 0], [0, 0]]
 

 output:        [[[[1]]], [[[2]]], [[[3]]], [[[4]]]]
 output shape:  [4, 1, 1, 1]
 

Note that after zero padding, the height and width of the input must be divisible by the block size.

Author:

Max Pumperla

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpaceToBatchLayer.Builder<T extends SpaceToBatchLayer.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	blocks
protected int[][]	padding

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

constraints, iDropout, layerName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpaceToBatchLayer(SpaceToBatchLayer.Builder builder)

Method Summary

Modifier and Type	Method and Description
SpaceToBatchLayer	clone()
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> trainingListeners, int layerIndex, INDArray layerParamsView, boolean initializeParams, org.nd4j.linalg.api.buffer.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

blocks

protected int[] blocks

padding

protected int[][] padding

Constructor Detail

SpaceToBatchLayer

protected SpaceToBatchLayer(SpaceToBatchLayer.Builder builder)

Method Detail

clone

public SpaceToBatchLayer clone()

Overrides:

clone in class Layer

instantiate

public Layer instantiate(NeuralNetConfiguration conf,
                         Collection<TrainingListener> trainingListeners,
                         int layerIndex,
                         INDArray layerParamsView,
                         boolean initializeParams,
                         org.nd4j.linalg.api.buffer.DataType networkDataType)

Specified by:

instantiate in class Layer

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

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

initializer

public ParamInitializer initializer()

Overrides:

initializer in class NoParamLayer

Returns:

The parameter initializer for this model

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