Upsampling2D (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.deeplearning4j.nn.conf.layers.Layer
- - org.deeplearning4j.nn.conf.layers.NoParamLayer
  - - org.deeplearning4j.nn.conf.layers.BaseUpsamplingLayer
    - - org.deeplearning4j.nn.conf.layers.Upsampling2D

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig
```
public class Upsampling2D
extends BaseUpsamplingLayer
```
Upsampling 2D layer
Repeats each value (or rather, set of depth values) in the height and width dimensions by size[0] and size[1] times respectively.
If input has shape [minibatch, channels, height, width] then output has shape [minibatch, channels, height*size[0], width*size[1]]
Example:
```
 Input (slice for one example and channel)
 [ A, B ]
 [ C, D ]
 Size = [2, 2]
 Output (slice for one example and channel)
 [ A, A, B, B ]
 [ A, A, B, B ]
 [ C, C, D, D ]
 [ C, C, D, D ]
 
```
Author:

Max Pumperla

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Upsampling2D.Builder
- Nested classes/interfaces inherited from class org.deeplearning4j.nn.conf.layers.BaseUpsamplingLayer
  BaseUpsamplingLayer.UpsamplingBuilder<T extends BaseUpsamplingLayer.UpsamplingBuilder<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Upsampling2D.Builder`

Field Summary

Fields
Modifier and Type Field and Description

protected CNN2DFormat format

protected int[] size
- Fields inherited from class org.deeplearning4j.nn.conf.layers.Layer
  constraints, iDropout, layerName

Fields
Modifier and Type	Field and Description
`protected CNN2DFormat`	`format`
`protected int[]`	`size`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Upsampling2D(BaseUpsamplingLayer.UpsamplingBuilder builder)

Constructors
Modifier	Constructor and Description
`protected`	`Upsampling2D(BaseUpsamplingLayer.UpsamplingBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Upsampling2D`	`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?
`Layer`	`instantiate(NeuralNetConfiguration conf, Collection<TrainingListener> trainingListeners, int layerIndex, INDArray layerParamsView, boolean initializeParams, DataType networkDataType)`
`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, initializer, isPretrainParam

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
  - size
```
protected int[] size
```
  - format
```
protected CNN2DFormat format
```
- Constructor Detail
  - Upsampling2D
```
protected Upsampling2D(BaseUpsamplingLayer.UpsamplingBuilder builder)
```
- Method Detail
  - clone
```
public Upsampling2D clone()
```
    Overrides:
    
    clone in class BaseUpsamplingLayer
  - instantiate
```
public Layer instantiate(NeuralNetConfiguration conf,
                         Collection<TrainingListener> trainingListeners,
                         int layerIndex,
                         INDArray layerParamsView,
                         boolean initializeParams,
                         DataType networkDataType)
```
    Specified by:
    
    instantiate in class 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
  - 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
    
    Overrides:
    
    getPreProcessorForInputType in class BaseUpsamplingLayer
    
    Parameters:
    
    inputType - InputType to this layer
    
    Returns:
    
    Null if no preprocessor is required, otherwise the type of preprocessor necessary for this layer/input combination
  - 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
  - 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.

Class Upsampling2D

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

size

format

Constructor Detail

Upsampling2D

Method Detail

clone

instantiate

getOutputType

getPreProcessorForInputType

getMemoryReport

setNIn