org.nd4j.linalg.api.ops.impl.controlflow

Class While

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.impl.controlflow.While

All Implemented Interfaces:

CustomOp

Direct Known Subclasses:

WhileDerivative

public class While
extends DifferentialFunction
implements CustomOp

Equivalent to tensorflow's while loop Takes in: loopVars loop body condition runs loop till condition is false.

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected String	blockName
protected SDVariable	dummyResult
protected SDVariable[]	inputVars
protected SameDiff	loopBodyExecution
protected int	numLooped
protected SDVariable[]	outputVars
protected SameDiff.SameDiffConditional	predicate
protected SameDiff	predicateExecution
protected SDVariable	targetBoolean
protected SameDiff.SameDiffFunctionDefinition	trueBody
protected String	trueBodyName

Fields inherited from class org.nd4j.autodiff.functions.DifferentialFunction

dimensions, extraArgs, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
While(AtomicInteger startPosition) Mainly meant for tensorflow import.
While(String blockName, SameDiff parent, SDVariable[] inputVars, SameDiff.SameDiffConditional predicate, SameDiff.SameDiffFunctionDefinition condition, SameDiff.SameDiffFunctionDefinition trueBody)
While(While whileStatement)

Method Summary

Modifier and Type	Method and Description
void	addIArgument(int... arg)
void	addInputArgument(INDArray... arg)
void	addOutputArgument(INDArray... arg)
void	addTArgument(double... arg)
void	assertValidForExecution() Asserts a valid state for execution, otherwise throws an ND4JIllegalStateException
List<int[]>	calculateOutputShape() Calculate the output shape for this op
List<SDVariable>	doDiff(List<SDVariable> f1) The actual implementation for automatic differentiation.
CustomOpDescriptor	getDescriptor() Get the custom op descriptor if one is available.
Integer	getIArgument(int index)
INDArray	getInputArgument(int index)
INDArray	getOutputArgument(int index)
Double	getTArgument(int index)
int[]	iArgs()
void	incrementLoopCounter() Increments the loop counter.
void	initFromOnnx(OnnxProto3.NodeProto node, SameDiff initWith, Map<String,OnnxProto3.AttributeProto> attributesForNode, OnnxProto3.GraphProto graph) Iniitialize the function from the given OnnxProto3.NodeProto
void	initFromTensorFlow(NodeDef nodeDef, SameDiff initWith, Map<String,AttrValue> attributesForNode, GraphDef graph) Initialize the function from the given NodeDef
INDArray[]	inputArguments()
boolean	isInplaceCall() This method returns true if op is supposed to be executed inplace
int	numIArguments()
int	numInputArguments()
int	numOutputArguments()
int	numTArguments()
String	onnxName() The opName of this function in onnx
long	opHash() This method returns LongHash of the opName()
String	opName() The name of the op
Op.Type	opType() The type of the op
INDArray[]	outputArguments()
SDVariable[]	outputVariables(String baseName) Return the output functions for this differential function.
void	populateInputsAndOutputsFromSameDiff() Attempt to populate inputs and outputs from samediff.
void	removeIArgument(Integer arg)
void	removeInputArgument(INDArray arg)
void	removeOutputArgument(INDArray arg)
void	removeTArgument(Double arg)
double[]	tArgs()
String	tensorflowName() The opName of this function tensorflow
String[]	tensorflowNames() The opName of this function tensorflow
String	toString()

Methods inherited from class org.nd4j.autodiff.functions.DifferentialFunction

arg, args, asProperties, attributeAdaptersForFunction, configFieldName, diff, dup, equals, f, getValue, hashCode, hasPlaceHolderInputs, isConfigProperties, larg, mappingsForFunction, onnxNames, opNum, outputVariables, propertiesForFunction, rarg, resolvePropertiesFromSameDiffBeforeExecution, setInstanceId, setValueFor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

loopBodyExecution

protected SameDiff loopBodyExecution

predicateExecution

protected SameDiff predicateExecution

predicate

protected SameDiff.SameDiffConditional predicate

trueBody

protected SameDiff.SameDiffFunctionDefinition trueBody

blockName

protected String blockName

trueBodyName

protected String trueBodyName

inputVars

protected SDVariable[] inputVars

targetBoolean

protected SDVariable targetBoolean

dummyResult

protected SDVariable dummyResult

outputVars

protected SDVariable[] outputVars

numLooped

protected int numLooped

Constructor Detail

While

public While(AtomicInteger startPosition)

Mainly meant for tensorflow import. This allows initFromTensorFlow(NodeDef, SameDiff, Map, GraphDef) to continue from a parent while loop using the same graph

Parameters:

startPosition - the start position for the import scan

While

public While(While whileStatement)

While

public While(String blockName,
             SameDiff parent,
             SDVariable[] inputVars,
             SameDiff.SameDiffConditional predicate,
             SameDiff.SameDiffFunctionDefinition condition,
             SameDiff.SameDiffFunctionDefinition trueBody)

Method Detail

outputVariables

public SDVariable[] outputVariables(String baseName)

Description copied from class: DifferentialFunction

Return the output functions for this differential function.

Specified by:

outputVariables in class DifferentialFunction

Returns:

doDiff

public List<SDVariable> doDiff(List<SDVariable> f1)

Description copied from class: DifferentialFunction

The actual implementation for automatic differentiation.

Specified by:

doDiff in class DifferentialFunction

Returns:

incrementLoopCounter

public void incrementLoopCounter()

Increments the loop counter. This should be called when the loop actually executes.

initFromTensorFlow

public void initFromTensorFlow(NodeDef nodeDef,
                               SameDiff initWith,
                               Map<String,AttrValue> attributesForNode,
                               GraphDef graph)

Description copied from class: DifferentialFunction

Initialize the function from the given NodeDef

Specified by:

initFromTensorFlow in class DifferentialFunction

initFromOnnx

public void initFromOnnx(OnnxProto3.NodeProto node,
                         SameDiff initWith,
                         Map<String,OnnxProto3.AttributeProto> attributesForNode,
                         OnnxProto3.GraphProto graph)

Description copied from class: DifferentialFunction

Iniitialize the function from the given OnnxProto3.NodeProto

Specified by:

initFromOnnx in class DifferentialFunction

toString

public String toString()

Overrides:

toString in class Object

opName

public String opName()

Description copied from class: DifferentialFunction

The name of the op

Specified by:

opName in interface CustomOp

Overrides:

opName in class DifferentialFunction

Returns:

opHash

public long opHash()

Description copied from interface: CustomOp

This method returns LongHash of the opName()

Specified by:

opHash in interface CustomOp

Returns:

isInplaceCall

public boolean isInplaceCall()

Description copied from interface: CustomOp

This method returns true if op is supposed to be executed inplace

Specified by:

isInplaceCall in interface CustomOp

Returns:

outputArguments

public INDArray[] outputArguments()

Specified by:

outputArguments in interface CustomOp

inputArguments

public INDArray[] inputArguments()

Specified by:

inputArguments in interface CustomOp

iArgs

public int[] iArgs()

Specified by:

iArgs in interface CustomOp

tArgs

public double[] tArgs()

Specified by:

tArgs in interface CustomOp

addIArgument

public void addIArgument(int... arg)

Specified by:

addIArgument in interface CustomOp

removeIArgument

public void removeIArgument(Integer arg)

Specified by:

removeIArgument in interface CustomOp

getIArgument

public Integer getIArgument(int index)

Specified by:

getIArgument in interface CustomOp

numIArguments

public int numIArguments()

Specified by:

numIArguments in interface CustomOp

addTArgument

public void addTArgument(double... arg)

Specified by:

addTArgument in interface CustomOp

removeTArgument

public void removeTArgument(Double arg)

Specified by:

removeTArgument in interface CustomOp

getTArgument

public Double getTArgument(int index)

Specified by:

getTArgument in interface CustomOp

numTArguments

public int numTArguments()

Specified by:

numTArguments in interface CustomOp

addInputArgument

public void addInputArgument(INDArray... arg)

Specified by:

addInputArgument in interface CustomOp

removeInputArgument

public void removeInputArgument(INDArray arg)

Specified by:

removeInputArgument in interface CustomOp

getInputArgument

public INDArray getInputArgument(int index)

Specified by:

getInputArgument in interface CustomOp

numInputArguments

public int numInputArguments()

Specified by:

numInputArguments in interface CustomOp

addOutputArgument

public void addOutputArgument(INDArray... arg)

Specified by:

addOutputArgument in interface CustomOp

removeOutputArgument

public void removeOutputArgument(INDArray arg)

Specified by:

removeOutputArgument in interface CustomOp

getOutputArgument

public INDArray getOutputArgument(int index)

Specified by:

getOutputArgument in interface CustomOp

numOutputArguments

public int numOutputArguments()

Specified by:

numOutputArguments in interface CustomOp

calculateOutputShape

public List<int[]> calculateOutputShape()

Description copied from class: DifferentialFunction

Calculate the output shape for this op

Specified by:

calculateOutputShape in interface CustomOp

Overrides:

calculateOutputShape in class DifferentialFunction

Returns:

getDescriptor

public CustomOpDescriptor getDescriptor()

Description copied from interface: CustomOp

Get the custom op descriptor if one is available.

Specified by:

getDescriptor in interface CustomOp

Returns:

assertValidForExecution

public void assertValidForExecution()

Description copied from interface: CustomOp

Asserts a valid state for execution, otherwise throws an ND4JIllegalStateException

Specified by:

assertValidForExecution in interface CustomOp

populateInputsAndOutputsFromSameDiff

public void populateInputsAndOutputsFromSameDiff()

Description copied from interface: CustomOp

Attempt to populate inputs and outputs from samediff. This method will not attempt to fill in integer or double aruguments.

Specified by:

populateInputsAndOutputsFromSameDiff in interface CustomOp

onnxName

public String onnxName()

Description copied from class: DifferentialFunction

The opName of this function in onnx

Specified by:

onnxName in class DifferentialFunction

Returns:

tensorflowName

public String tensorflowName()

Description copied from class: DifferentialFunction

The opName of this function tensorflow

Specified by:

tensorflowName in class DifferentialFunction

Returns:

tensorflowNames

public String[] tensorflowNames()

Description copied from class: DifferentialFunction

The opName of this function tensorflow

Overrides:

tensorflowNames in class DifferentialFunction

Returns:

opType

public Op.Type opType()

Description copied from class: DifferentialFunction

The type of the op

Overrides:

opType in class DifferentialFunction

Returns: