org.deeplearning4j.nn.graph.vertex.impl.rnn

Class DuplicateToTimeSeriesVertex

java.lang.Object

org.deeplearning4j.nn.graph.vertex.BaseGraphVertex

org.deeplearning4j.nn.graph.vertex.impl.rnn.DuplicateToTimeSeriesVertex

All Implemented Interfaces:

Serializable, Trainable, GraphVertex

public class DuplicateToTimeSeriesVertex
extends BaseGraphVertex

DuplicateToTimeSeriesVertex is a vertex that goes from 2d activations to a 3d time series activations, by means of duplication. That is, given a 2d input with shape [numExamples,nIn] duplicate each row to give output of [numExamples,nIn,timeSeriesLength], where the activations are the same for all time steps.
This method is used for example in sequence to sequence models.
Note: The length of the output time series (number of time steps) is determined by means of referencing one of the inputs in the ComputationGraph. That is: Because the length of the time series may differ at runtime, we generally want the number of time steps to match some other input; here, we are specifying the length of the output time series to be the same as one of the input time series

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields inherited from class org.deeplearning4j.nn.graph.vertex.BaseGraphVertex

dataType, epsilon, graph, inputs, inputVertices, outputVertex, outputVertices, vertexIndex, vertexName

Constructor Summary

Constructors

Constructor and Description
DuplicateToTimeSeriesVertex(ComputationGraph graph, String name, int vertexIndex, String inputVertexName, DataType dataType)
DuplicateToTimeSeriesVertex(ComputationGraph graph, String name, int vertexIndex, VertexIndices[] inputVertices, VertexIndices[] outputVertices, String inputName, DataType dataType)

Method Summary

Modifier and Type	Method and Description
Pair<Gradient,INDArray[]>	doBackward(boolean tbptt, LayerWorkspaceMgr workspaceMgr) Do backward pass
INDArray	doForward(boolean training, LayerWorkspaceMgr workspaceMgr) Do forward pass using the stored inputs
Pair<INDArray,MaskState>	feedForwardMaskArrays(INDArray[] maskArrays, MaskState currentMaskState, int minibatchSize)
Layer	getLayer() Get the Layer (if any).
boolean	hasLayer() Whether the GraphVertex contains a Layer object or not
boolean	isOutputVertex() Whether the GraphVertex is an output vertex
void	setBackpropGradientsViewArray(INDArray backpropGradientsViewArray) See Model.setBackpropGradientsViewArray(INDArray)
String	toString()

Methods inherited from class org.deeplearning4j.nn.graph.vertex.BaseGraphVertex

canDoBackward, canDoForward, clear, clearVertex, getConfig, getEpsilon, getGradientsViewArray, getInputVertices, getNumInputArrays, getNumOutputConnections, getOutputVertices, getVertexIndex, getVertexName, isInputVertex, numParams, params, paramTable, setEpsilon, setInput, setInputVertices, setLayerAsFrozen, setOutputVertices, updaterDivideByMinibatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.deeplearning4j.nn.graph.vertex.GraphVertex

getInputs, setInputs, setOutputVertex

Constructor Detail

DuplicateToTimeSeriesVertex

public DuplicateToTimeSeriesVertex(ComputationGraph graph,
                                   String name,
                                   int vertexIndex,
                                   String inputVertexName,
                                   DataType dataType)

DuplicateToTimeSeriesVertex

public DuplicateToTimeSeriesVertex(ComputationGraph graph,
                                   String name,
                                   int vertexIndex,
                                   VertexIndices[] inputVertices,
                                   VertexIndices[] outputVertices,
                                   String inputName,
                                   DataType dataType)

Method Detail

hasLayer

public boolean hasLayer()

Description copied from interface: GraphVertex

Whether the GraphVertex contains a Layer object or not

isOutputVertex

public boolean isOutputVertex()

Description copied from interface: GraphVertex

Whether the GraphVertex is an output vertex

getLayer

public Layer getLayer()

Description copied from interface: GraphVertex

Get the Layer (if any). Returns null if GraphVertex.hasLayer() == false

doForward

public INDArray doForward(boolean training,
                          LayerWorkspaceMgr workspaceMgr)

Description copied from interface: GraphVertex

Do forward pass using the stored inputs

Parameters:

training - if true: forward pass at training time. If false: forward pass at test time

Returns:

The output (for example, activations) of the GraphVertex

doBackward

public Pair<Gradient,INDArray[]> doBackward(boolean tbptt,
                                            LayerWorkspaceMgr workspaceMgr)

Description copied from interface: GraphVertex

Do backward pass

Parameters:

tbptt - If true: do backprop using truncated BPTT

Returns:

The gradients (may be null), and the errors/epsilons for all inputs to this GraphVertex

setBackpropGradientsViewArray

public void setBackpropGradientsViewArray(INDArray backpropGradientsViewArray)

Description copied from interface: GraphVertex

See Model.setBackpropGradientsViewArray(INDArray)

feedForwardMaskArrays

public Pair<INDArray,MaskState> feedForwardMaskArrays(INDArray[] maskArrays,
                                                      MaskState currentMaskState,
                                                      int minibatchSize)

toString

public String toString()

Specified by:

toString in class BaseGraphVertex