org.deeplearning4j.nn.conf.layers.samediff

Class SameDiffLambdaLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.samediff.AbstractSameDiffLayer

org.deeplearning4j.nn.conf.layers.samediff.SameDiffLayer

org.deeplearning4j.nn.conf.layers.samediff.SameDiffLambdaLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

Direct Known Subclasses:

CapsuleStrengthLayer, IdentityLayer

public abstract class SameDiffLambdaLayer
extends SameDiffLayer

SameDiffLambdaLayer is defined to be used as the base class for implementing lambda layers using SameDiff
Lambda layers are layers without parameters - and as a result, have a much simpler API - users need only extend SameDiffLambdaLayer and implement a single method

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

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

SameDiffLayer.Builder<T extends SameDiffLayer.Builder<T>>

Field Summary

Fields inherited from class org.deeplearning4j.nn.conf.layers.samediff.SameDiffLayer

paramWeightInit, weightInit

Fields inherited from class org.deeplearning4j.nn.conf.layers.samediff.AbstractSameDiffLayer

biasUpdater, gradientNormalization, gradientNormalizationThreshold, regularization, regularizationBias, updater

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

constraints, iDropout, layerName

Constructor Summary

Constructors

Constructor and Description
SameDiffLambdaLayer()

Method Summary

Modifier and Type	Method and Description
abstract SDVariable	defineLayer(SameDiff sameDiff, SDVariable layerInput) The defineLayer method is used to define the foward pass for the layer
SDVariable	defineLayer(SameDiff sameDiff, SDVariable layerInput, Map<String,SDVariable> paramTable, SDVariable mask) Define the layer
void	defineParameters(SDLayerParams params) Define the parameters for the network.
InputType	getOutputType(int layerIndex, InputType inputType) For a given type of input to this layer, what is the type of the output?
void	initializeParameters(Map<String,INDArray> params) Set the initial parameter values for this layer, if required

Methods inherited from class org.deeplearning4j.nn.conf.layers.samediff.SameDiffLayer

feedForwardMaskArray, instantiate, validateInput

Methods inherited from class org.deeplearning4j.nn.conf.layers.samediff.AbstractSameDiffLayer

applyGlobalConfig, applyGlobalConfigToLayer, getLayerParams, getMemoryReport, getPreProcessorForInputType, getRegularizationByParam, getUpdaterByParam, initializer, initWeights, isPretrainParam, onesMaskForInput, paramReshapeOrder, setNIn

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

clone, 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

getGradientNormalization, getGradientNormalizationThreshold, getLayerName

Constructor Detail

SameDiffLambdaLayer

public SameDiffLambdaLayer()

Method Detail

defineLayer

public abstract SDVariable defineLayer(SameDiff sameDiff,
                                       SDVariable layerInput)

The defineLayer method is used to define the foward pass for the layer

Parameters:

sameDiff - SameDiff instance to use to define the vertex

layerInput - Layer input variable

Returns:

The output variable (orresponding to the output activations for the layer)

defineLayer

public SDVariable defineLayer(SameDiff sameDiff,
                              SDVariable layerInput,
                              Map<String,SDVariable> paramTable,
                              SDVariable mask)

Description copied from class: SameDiffLayer

Define the layer

Specified by:

defineLayer in class SameDiffLayer

Parameters:

sameDiff - SameDiff instance

layerInput - Input to the layer

paramTable - Parameter table - keys as defined by AbstractSameDiffLayer.defineParameters(SDLayerParams)

mask - Optional, maybe null. Mask to apply if supported

Returns:

The final layer variable corresponding to the activations/output from the forward pass

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

defineParameters

public void defineParameters(SDLayerParams params)

Description copied from class: AbstractSameDiffLayer

Define the parameters for the network. Use SDLayerParams.addWeightParam(String, long...) and SDLayerParams.addBiasParam(String, long...)

Specified by:

defineParameters in class AbstractSameDiffLayer

Parameters:

params - Object used to set parameters for this layer

initializeParameters

public void initializeParameters(Map<String,INDArray> params)

Description copied from class: AbstractSameDiffLayer

Set the initial parameter values for this layer, if required

Specified by:

initializeParameters in class AbstractSameDiffLayer

Parameters:

params - Parameter arrays that may be initialized