org.deeplearning4j.nn.conf.layers

Class CapsuleLayer

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

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

public class CapsuleLayer
extends SameDiffLayer

An implementation of the DigiCaps layer from Dynamic Routing Between Capsules Input should come from a PrimaryCapsules layer and be of shape [mb, inputCaps, inputCapDims]. From Dynamic Routing Between Capsules

Author:

Ryan Nett

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapsuleLayer.Builder

Field Summary

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

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
CapsuleLayer(CapsuleLayer.Builder builder)

Method Summary

Modifier and Type	Method and Description
SDVariable	defineLayer(SameDiff SD, SDVariable input, 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
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.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

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

CapsuleLayer

public CapsuleLayer(CapsuleLayer.Builder builder)

Method Detail

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 AbstractSameDiffLayer

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.

defineLayer

public SDVariable defineLayer(SameDiff SD,
                              SDVariable input,
                              Map<String,SDVariable> paramTable,
                              SDVariable mask)

Description copied from class: SameDiffLayer

Define the layer

Specified by:

defineLayer in class SameDiffLayer

Parameters:

SD - SameDiff instance

input - 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

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

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