org.deeplearning4j.nn.conf.graph

Class PreprocessorVertex

java.lang.Object

org.deeplearning4j.nn.conf.graph.GraphVertex

org.deeplearning4j.nn.conf.graph.PreprocessorVertex

All Implemented Interfaces:

Serializable, Cloneable

public class PreprocessorVertex
extends GraphVertex

PreprocessorVertex is a simple adaptor class that allows a InputPreProcessor to be used in a ComputationGraph GraphVertex, without it being associated with a layer.

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PreprocessorVertex(InputPreProcessor preProcessor)
PreprocessorVertex(InputPreProcessor preProcessor, InputType outputType) Deprecated. This constructor (and the "InputType override" functionality previously used is no longer necessary.

Method Summary

Modifier and Type	Method and Description
GraphVertex	clone()
boolean	equals(Object o)
InputType	getOutputType(InputType... vertexInputs) Determine the type of output for this GraphVertex, given the specified inputs.
int	hashCode()
GraphVertex	instantiate(ComputationGraph graph, String name, int idx, org.nd4j.linalg.api.ndarray.INDArray paramsView, boolean initializeParams) Create a GraphVertex instance, for the given computation graph, given the configuration instance.
int	numParams(boolean backprop)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreprocessorVertex

public PreprocessorVertex(InputPreProcessor preProcessor)

PreprocessorVertex

@Deprecated
public PreprocessorVertex(InputPreProcessor preProcessor,
                                      InputType outputType)

Deprecated. This constructor (and the "InputType override" functionality previously used is no longer necessary.

Parameters:

preProcessor - The input preprocessor

outputType - Override for the type of output used in getOutputType(InputType...). This may be necessary for the automatic addition of other processors in the network, given a custom/non-standard InputPreProcessor

Method Detail

clone

public GraphVertex clone()

Specified by:

clone in class GraphVertex

equals

public boolean equals(Object o)

Specified by:

equals in class GraphVertex

hashCode

public int hashCode()

Specified by:

hashCode in class GraphVertex

numParams

public int numParams(boolean backprop)

Specified by:

numParams in class GraphVertex

instantiate

public GraphVertex instantiate(ComputationGraph graph,
                               String name,
                               int idx,
                               org.nd4j.linalg.api.ndarray.INDArray paramsView,
                               boolean initializeParams)

Description copied from class: GraphVertex

Create a GraphVertex instance, for the given computation graph, given the configuration instance.

Specified by:

instantiate in class GraphVertex

Parameters:

graph - The computation graph that this GraphVertex is to be part of

name - The name of the GraphVertex object

idx - The index of the GraphVertex

paramsView - A view of the full parameters array

initializeParams - If true: initialize the parameters. If false: make no change to the values in the paramsView array

Returns:

The implementation GraphVertex object (i.e., implementation, no the configuration)

getOutputType

public InputType getOutputType(InputType... vertexInputs)
                        throws InvalidInputTypeException

Description copied from class: GraphVertex

Determine the type of output for this GraphVertex, given the specified inputs. Given that a GraphVertex may do arbitrary processing or modifications of the inputs, the output types can be quite different to the input type(s).
This is generally used to determine when to add preprocessors, as well as the input sizes etc for layers

Specified by:

getOutputType in class GraphVertex

Parameters:

vertexInputs - The inputs to this vertex

Returns:

The type of output for this vertex

Throws:

InvalidInputTypeException - If the input type is invalid for this type of GraphVertex