BaseLayer (deeplearning4j-nn 0.9.1 API)

java.lang.Object
- org.deeplearning4j.nn.conf.layers.Layer
- - org.deeplearning4j.nn.conf.layers.BaseLayer

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

FeedForwardLayer
```
public abstract class BaseLayer
extends Layer
implements Serializable, Cloneable
```
A neural network layer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseLayer.Builder<T extends BaseLayer.Builder<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseLayer.Builder<T extends BaseLayer.Builder<T>>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.nd4j.linalg.activations.IActivation`	`activationFn`
`protected double`	`adamMeanDecay` Deprecated.
`protected double`	`adamVarDecay` Deprecated.
`protected double`	`biasInit`
`protected double`	`biasLearningRate`
`protected Distribution`	`dist`
`protected double`	`epsilon` Deprecated.
`protected GradientNormalization`	`gradientNormalization`
`protected double`	`gradientNormalizationThreshold`
`protected org.nd4j.linalg.learning.config.IUpdater`	`iUpdater`
`protected double`	`l1`
`protected double`	`l1Bias`
`protected double`	`l2`
`protected double`	`l2Bias`
`protected double`	`learningRate`
`protected Map<Integer,Double>`	`learningRateSchedule`
`protected double`	`momentum` Deprecated.
`protected Map<Integer,Double>`	`momentumSchedule` Deprecated.
`protected double`	`rho` Deprecated.
`protected double`	`rmsDecay` Deprecated.
`protected Updater`	`updater` Deprecated.
`protected WeightInit`	`weightInit`

Fields inherited from class org.deeplearning4j.nn.conf.layers.Layer
dropOut, layerName

Constructor Summary

Constructors
Constructor and Description

BaseLayer(BaseLayer.Builder builder)

Constructors
Constructor and Description
`BaseLayer(BaseLayer.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BaseLayer`	`clone()`
`org.nd4j.linalg.learning.config.IUpdater`	`getIUpdaterByParam(String paramName)` Get the updater for the given parameter.
`Updater`	`getUpdaterByParam(String paramName)` Deprecated. Use `getIUpdaterByParam(String)`
`void`	`resetLayerDefaultConfig()` Reset the learning related configs of the layer to default.

Methods inherited from class org.deeplearning4j.nn.conf.layers.Layer
getL1ByParam, getL2ByParam, getLearningRateByParam, getMemoryReport, getOutputType, getPreProcessorForInputType, initializer, instantiate, isPretrainParam, setNIn

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - activationFn
```
protected org.nd4j.linalg.activations.IActivation activationFn
```
  - weightInit
```
protected WeightInit weightInit
```
  - biasInit
```
protected double biasInit
```
  - dist
```
protected Distribution dist
```
  - learningRate
```
protected double learningRate
```
  - biasLearningRate
```
protected double biasLearningRate
```
  - learningRateSchedule
```
protected Map<Integer,Double> learningRateSchedule
```
  - momentum
```
@Deprecated
protected double momentum
```
    Deprecated.
  - momentumSchedule
```
@Deprecated
protected Map<Integer,Double> momentumSchedule
```
    Deprecated.
  - l1
```
protected double l1
```
  - l2
```
protected double l2
```
  - l1Bias
```
protected double l1Bias
```
  - l2Bias
```
protected double l2Bias
```
  - updater
```
@Deprecated
protected Updater updater
```
    Deprecated.
  - iUpdater
```
protected org.nd4j.linalg.learning.config.IUpdater iUpdater
```
  - rho
```
@Deprecated
protected double rho
```
    Deprecated.
  - epsilon
```
@Deprecated
protected double epsilon
```
    Deprecated.
  - rmsDecay
```
@Deprecated
protected double rmsDecay
```
    Deprecated.
  - adamMeanDecay
```
@Deprecated
protected double adamMeanDecay
```
    Deprecated.
  - adamVarDecay
```
@Deprecated
protected double adamVarDecay
```
    Deprecated.
  - gradientNormalization
```
protected GradientNormalization gradientNormalization
```
  - gradientNormalizationThreshold
```
protected double gradientNormalizationThreshold
```
- Constructor Detail
  - BaseLayer
```
public BaseLayer(BaseLayer.Builder builder)
```
- Method Detail
  - resetLayerDefaultConfig
```
public void resetLayerDefaultConfig()
```
    Reset the learning related configs of the layer to default. When instantiated with a global neural network configuration the parameters specified in the neural network configuration will be used. For internal use with the transfer learning API. Users should not have to call this method directly.
    
    Overrides:
    
    resetLayerDefaultConfig in class Layer
  - clone
```
public BaseLayer clone()
```
    Overrides:
    
    clone in class Layer
  - getUpdaterByParam
```
@Deprecated
public Updater getUpdaterByParam(String paramName)
```
    Deprecated. Use getIUpdaterByParam(String)
    
    Get the updater for the given parameter. Typically the same updater will be used for all updaters, but this is not necessarily the case
    
    Overrides:
    
    getUpdaterByParam in class Layer
    
    Parameters:
    
    paramName - Parameter name
    
    Returns:
    
    Updater for the parameter
  - getIUpdaterByParam
```
public org.nd4j.linalg.learning.config.IUpdater getIUpdaterByParam(String paramName)
```
    Get the updater for the given parameter. Typically the same updater will be used for all updaters, but this is not necessarily the case
    
    Overrides:
    
    getIUpdaterByParam in class Layer
    
    Parameters:
    
    paramName - Parameter name
    
    Returns:
    
    IUpdater for the parameter

Class BaseLayer

Nested Class Summary

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

Methods inherited from class java.lang.Object

Field Detail

activationFn

weightInit

biasInit

dist

learningRate

biasLearningRate

learningRateSchedule

momentum

momentumSchedule

l1

l2

l1Bias

l2Bias

updater

iUpdater

rho

epsilon

rmsDecay

adamMeanDecay

adamVarDecay

gradientNormalization

gradientNormalizationThreshold

Constructor Detail

BaseLayer

Method Detail

resetLayerDefaultConfig

clone

getUpdaterByParam

getIUpdaterByParam