org.deeplearning4j.nn.graph.vertex.impl

Class ElementWiseVertex

java.lang.Object

org.deeplearning4j.nn.graph.vertex.BaseGraphVertex

org.deeplearning4j.nn.graph.vertex.impl.ElementWiseVertex

All Implemented Interfaces:

Serializable, Trainable, GraphVertex

public class ElementWiseVertex
extends BaseGraphVertex

An ElementWiseVertex is used to combine the activations of two or more layer in an element-wise manner
For example, the activations may be combined by addition, subtraction or multiplication or by selecting the maximum. Addition, Average, Product and Max may use an arbitrary number of input arrays. Note that in the case of subtraction, only two inputs may be used. In all cases, the shape of the input arrays must be identical.

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElementWiseVertex.Op

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ElementWiseVertex(ComputationGraph graph, String name, int vertexIndex, ElementWiseVertex.Op op)
ElementWiseVertex(ComputationGraph graph, String name, int vertexIndex, VertexIndices[] inputVertices, VertexIndices[] outputVertices, ElementWiseVertex.Op op)

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

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, isOutputVertex, setInputs, setOutputVertex

Constructor Detail

ElementWiseVertex

public ElementWiseVertex(ComputationGraph graph,
                         String name,
                         int vertexIndex,
                         ElementWiseVertex.Op op)

ElementWiseVertex

public ElementWiseVertex(ComputationGraph graph,
                         String name,
                         int vertexIndex,
                         VertexIndices[] inputVertices,
                         VertexIndices[] outputVertices,
                         ElementWiseVertex.Op op)

Method Detail

hasLayer

public boolean hasLayer()

Description copied from interface: GraphVertex

Whether the GraphVertex contains a Layer object or not

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