org.nd4j.linalg.api.ops

Class DynamicCustomOp

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.DynamicCustomOp

All Implemented Interfaces:

CustomOp

Direct Known Subclasses:

ApplyGradientDescent, Assign, AvgPooling2D, BaseCompatOp, BaseDynamicTransformOp, BaseModule, BaseTensorOp, BatchNorm, BatchToSpace, BiasAdd, Broadcast, Choose, ClipByNorm, ClipByValue, Col2Im, Concat, ConfusionMatrix, Conv1D, Conv2D, Conv3D, Cross, CumProd, CumSum, DeConv2D, DepthToSpace, DepthwiseConv2D, Diag, DiagPart, Dilation2D, DistributionUniform, DynamicPartition, DynamicStitch, ExpandDims, Eye, Fill, FullConv3D, Gather, GatherNd, GRUCell, Im2col, IsNonDecreasing, IsNumericTensor, IsStrictlyIncreasing, ListDiff, LocalResponseNormalization, LSTMCell, MatrixDiagPart, MatrixSetDiag, MaxPooling2D, MergeAvg, MergeMax, MergeSum, Mmul, Moments, NoOp, NormalizeMoments, OneHot, OnesLike, ParallelStack, Pooling2D, Pooling3D, Range, Rank, ReluLayer, Repeat, Reshape, RestoreV2, Reverse, ReverseSequence, SaveV2, ScatterAdd, ScatterDiv, ScatterMul, ScatterSub, Select, SequenceMask, Shape, SigmoidCrossEntropyLoss, Slice, SoftmaxCrossEntropyLoss, SpaceToBatch, SpaceToDepth, Split, SplitV, Squeeze, SRU, SRUCell, Stack, StridedSlice, TensorMmul, Tile, Transpose, Unstack, Upsampling, WeightedCrossEntropyLoss, Where, WhereNumpy, XwPlusB, ZeroFraction, ZerosLike

public class DynamicCustomOp
extends DifferentialFunction
implements CustomOp

Basic implementation for CustomOp

Author:

raver119@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicCustomOp.DynamicCustomOpsBuilder
static class	DynamicCustomOp.SameDiffBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	inplaceCall
protected SDVariable[]	outputVariables

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

dimensions, extraArgs, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Modifier	Constructor and Description
	DynamicCustomOp()
protected	DynamicCustomOp(String opName)
	DynamicCustomOp(String opName, INDArray[] inputs, INDArray[] outputs) Initialize this operation for execution (pre created ndarrays)
	DynamicCustomOp(String opName, INDArray[] inputs, INDArray[] outputs, List<Double> tArguments, List<Integer> iArguments) Initialize this custom op with all of the inputs, outputs, and respective arguments for execution
	DynamicCustomOp(String opName, SameDiff sameDiff, SDVariable[] args)
	DynamicCustomOp(String opName, SameDiff sameDiff, SDVariable[] args, boolean inPlace) Initialize this for SameDiff execution Any extra int or float arguments for operations must be added to the respective TArguments or IArguments lists upon construction

Method Summary

Modifier and Type	Method and Description
void	addIArgument(int... arg)
void	addInputArgument(INDArray... arg)
void	addOutputArgument(INDArray... arg)
void	addTArgument(double... arg)
FunctionProperties	asProperties() Return function properties for the given function
void	assertValidForExecution() Asserts a valid state for execution, otherwise throws an ND4JIllegalStateException
static DynamicCustomOp.DynamicCustomOpsBuilder	builder(String opName) This method takes custom opname, and return Op DynamicCustomOpsBuilder instance
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	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()
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() This method returns op opName as string
int	opNum() The number of the op (mainly for old legacy XYZ ops like Op)
Op.Type	opType() The type of the op
INDArray[]	outputArguments()
SDVariable[]	outputVariables() Return the output variables for this differential function.
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)
static DynamicCustomOp.SameDiffBuilder	sameDiffBuilder(String opName, SameDiff sameDiff)
void	setInputArgument(int index, INDArray input)
void	setOutputArgument(int index, INDArray output)
double[]	tArgs()
String	tensorflowName() The opName of this function tensorflow
String	toString()
void	updateInputsFromSameDiff()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.linalg.api.ops.CustomOp

isInplaceCall

Field Detail

inplaceCall

protected boolean inplaceCall

outputVariables

protected SDVariable[] outputVariables

Constructor Detail

DynamicCustomOp

public DynamicCustomOp()

DynamicCustomOp

public DynamicCustomOp(String opName,
                       SameDiff sameDiff,
                       SDVariable[] args)

DynamicCustomOp

public DynamicCustomOp(String opName,
                       INDArray[] inputs,
                       INDArray[] outputs,
                       List<Double> tArguments,
                       List<Integer> iArguments)

Initialize this custom op with all of the inputs, outputs, and respective arguments for execution

Parameters:

opName - the opName of the op to execute

inputs - the inputs to the op

outputs - the outputs of the op

tArguments - the input float arguments

iArguments - the input int arguments

DynamicCustomOp

public DynamicCustomOp(String opName,
                       INDArray[] inputs,
                       INDArray[] outputs)

Initialize this operation for execution (pre created ndarrays)

Parameters:

opName - the operation opName to use for invocation

inputs - the inputs

outputs - the outputs of the op

DynamicCustomOp

public DynamicCustomOp(String opName,
                       SameDiff sameDiff,
                       SDVariable[] args,
                       boolean inPlace)

Initialize this for SameDiff execution Any extra int or float arguments for operations must be added to the respective TArguments or IArguments lists upon construction

Parameters:

opName - the operation opName

sameDiff - the samediff instance to use

args - the arguments to use

inPlace - whether the operation is in place or not

DynamicCustomOp

protected DynamicCustomOp(String opName)

Method Detail

opName

public String opName()

This method returns op opName as string

Specified by:

opName in interface CustomOp

Overrides:

opName in class DifferentialFunction

Returns:

outputVariables

public SDVariable[] outputVariables()

Description copied from class: DifferentialFunction

Return the output variables for this differential function. Note that this op *may* dynamically generate variable outputs.

Overrides:

outputVariables in class DifferentialFunction

Returns:

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:

opHash

public long opHash()

This method returns LongHash of the opName()

Specified by:

opHash 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

setInputArgument

public void setInputArgument(int index,
                             INDArray input)

setOutputArgument

public void setOutputArgument(int index,
                              INDArray output)

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

opNum

public int opNum()

Description copied from class: DifferentialFunction

The number of the op (mainly for old legacy XYZ ops like Op)

Overrides:

opNum in class DifferentialFunction

Returns:

builder

public static DynamicCustomOp.DynamicCustomOpsBuilder builder(String opName)

This method takes custom opname, and return Op DynamicCustomOpsBuilder instance

Parameters:

opName -

Returns:

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

updateInputsFromSameDiff

public void updateInputsFromSameDiff()

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

asProperties

public FunctionProperties asProperties()

Return function properties for the given function

Overrides:

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

toString

public String toString()

Overrides:

toString in class Object

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:

opType

public Op.Type opType()

Description copied from class: DifferentialFunction

The type of the op

Overrides:

opType in class DifferentialFunction

Returns:

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

sameDiffBuilder

public static DynamicCustomOp.SameDiffBuilder sameDiffBuilder(String opName,
                                                              SameDiff sameDiff)