org.deeplearning4j.nn.conf.layers

Class EmbeddingSequenceLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.BaseLayer

org.deeplearning4j.nn.conf.layers.FeedForwardLayer

org.deeplearning4j.nn.conf.layers.EmbeddingSequenceLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

public class EmbeddingSequenceLayer
extends FeedForwardLayer

Embedding layer for sequences: feed-forward layer that expects fixed-length number (inputLength) of integers/indices per example as input, ranged from 0 to numClasses - 1. This input thus has shape [numExamples, inputLength] or shape [numExamples, 1, inputLength].
The output of this layer is 3D (sequence/time series), namely of shape [numExamples, nOut, inputLength]. Note: can only be used as the first layer for a network
Note 2: For a given example index i, the output is activationFunction(weights.getRow(i) + bias), hence the weight rows can be considered a vector/embedding of each index.
Note also that embedding layer has an activation function (set to IDENTITY to disable) and optional bias (which is disabled by default)

Author:

Max Pumperla

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddingSequenceLayer.Builder

Field Summary

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

nIn, nOut

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

activationFn, biasInit, biasUpdater, dist, gradientNormalization, gradientNormalizationThreshold, iUpdater, l1, l1Bias, l2, l2Bias, weightInit, weightNoise

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

constraints, iDropout, layerName

Method Summary

Modifier and Type	Method and Description
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?
boolean	hasBias()
ParamInitializer	initializer()
Layer	instantiate(NeuralNetConfiguration conf, Collection<TrainingListener> trainingListeners, int layerIndex, INDArray layerParamsView, boolean initializeParams)

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

getL1ByParam, getL2ByParam, getPreProcessorForInputType, isPretrain, isPretrainParam, setNIn

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

clone, getGradientNormalization, getUpdaterByParam, resetLayerDefaultConfig

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

initializeConstraints, setPretrain

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

getGradientNormalizationThreshold, getLayerName

Method Detail

instantiate

public Layer instantiate(NeuralNetConfiguration conf,
                         Collection<TrainingListener> trainingListeners,
                         int layerIndex,
                         INDArray layerParamsView,
                         boolean initializeParams)

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?

Overrides:

getOutputType in class FeedForwardLayer

Parameters:

layerIndex - Index of the layer

inputType - Type of input for the layer

Returns:

Type of output from the layer

initializer

public ParamInitializer initializer()

Specified by:

initializer in class Layer

Returns:

The parameter initializer for this model

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

hasBias

public boolean hasBias()