CustomOp (nd4j-api 1.0.0-beta5 API)

All Known Implementing Classes:

AbsoluteDifferenceLoss, AbsoluteDifferenceLossBp, AddBpOp, AddOp, Angle, ApplyGradientDescent, ArgMax, ArgMin, Assert, Assign, ATan2, AvgPooling2D, AvgPooling3D, BarnesEdgeForces, BarnesHutGains, BarnesHutSymmetrize, BaseArithmeticBackpropOp, BaseCompatOp, BaseDynamicTransformOp, BaseLoss, BaseLossBp, BaseReductionBp, BaseTensorOp, BatchMmul, BatchNorm, BatchNormDerivative, BatchToSpace, BatchToSpaceND, BiasAdd, BiasAddGrad, BinCount, BitsHammingDistance, BitwiseAnd, BitwiseOr, BitwiseXor, BroadcastDynamicShape, BroadcastTo, Cast, CbowRound, CheckNumerics, Cholesky, Choose, ClipByNorm, ClipByNormBp, ClipByValue, Col2Im, Concat, ConcatBp, ConfusionMatrix, Conv1D, Conv2D, Conv2DDerivative, Conv3D, Conv3DDerivative, CosineDistanceLoss, CosineDistanceLossBp, CropAndResize, Cross, CubeBp, CumProd, CumProdBp, CumSum, CumSumBp, CyclicRShiftBits, CyclicShiftBits, DeConv2D, DeConv2DDerivative, DeConv2DTF, DeConv3D, DeConv3DDerivative, DepthToSpace, DepthwiseConv2D, Diag, DiagPart, Dilation2D, DistributionUniform, DivBpOp, DivOp, DotBp, DotProductAttention, DotProductAttentionBp, DynamicCustomOp, DynamicPartition, DynamicPartitionBp, DynamicStitch, ELU, EluBp, Enter, EqualTo, Exit, ExpandDims, ExternalErrorsFunction, ExtractImagePatches, Eye, FakeQuantWithMinMaxArgs, FakeQuantWithMinMaxVars, Fill, Flatten, FloorDivBpOp, FloorDivOp, FloorModBpOp, FloorModOp, Gather, GatherNd, GradientBackwardsMarker, GreaterThan, GreaterThanOrEqual, GRUCell, HardSigmoidBp, HardTanhBp, HashCode, HingeLoss, HingeLossBp, Histogram, HistogramFixedWidth, HuberLoss, HuberLossBp, Identity, IdentityN, If, IfDerivative, Im2col, Im2colBp, InTopK, InvertPermutation, IsMax, IsNonDecreasing, IsNumericTensor, IsStrictlyIncreasing, L2Loss, LayerNorm, LayerNormBp, LeakyReLUBp, LessThan, LessThanOrEqual, Linspace, ListDiff, LocalResponseNormalization, LocalResponseNormalizationDerivative, LogicalAnd, LogicalNot, LogicalOr, LogicalXor, LogLoss, LogLossBp, LogMatrixDeterminant, LogPoissonLoss, LogPoissonLossBp, LogSoftMax, LogSoftMaxDerivative, LogSumExp, LoopCond, LSTMBlockCell, LSTMCell, LSTMLayer, MatrixDeterminant, MatrixDiag, MatrixDiagPart, MatrixInverse, MatrixSetDiag, Max, MaxBp, MaxPooling2D, MaxPooling3D, MeanBp, MeanPairwiseSquaredErrorLoss, MeanPairwiseSquaredErrorLossBp, MeanSquaredErrorLoss, MeanSquaredErrorLossBp, Merge, MergeAddOp, MergeAvg, MergeMax, MergeSum, MeshGrid, Min, MinBp, MirrorPad, Mmul, MmulBp, ModBpOp, ModOp, Moments, MulBpOp, MulOp, MultiHeadDotProductAttention, MultiHeadDotProductAttentionBp, NextIteration, NonMaxSuppression, NoOp, Norm1Bp, Norm2Bp, NormalizeMoments, NormMaxBp, NotEqualTo, NthElement, OneHot, OnesLike, Pad, ParallelConcat, ParallelStack, Permute, Pooling2D, Pooling2DDerivative, Pooling3D, Pooling3DDerivative, Pow, ProdBp, RandomBernoulli, RandomExponential, RandomNormal, RandomStandardNormal, Range, Rank, RationalTanhBp, RDivBpOp, RDivOp, RealDivOp, RectifiedLinearDerivative, RectifiedTanhBp, ReductionShape, Relu6Derivative, ReluLayer, Repeat, Reshape, ResizeBilinear, ResizeNearestNeighbor, RestoreV2, Reverse, ReverseSequence, ReverseV2, RShiftBits, RSubBpOp, RSubOp, SaveV2, ScatterAdd, ScatterDiv, ScatterMax, ScatterMin, ScatterMul, ScatterNd, ScatterNdAdd, ScatterNdSub, ScatterNdUpdate, ScatterSub, ScatterUpdate, ScatterUpdate, SConv2D, SConv2DDerivative, SegmentMax, SegmentMaxBp, SegmentMean, SegmentMeanBp, SegmentMin, SegmentMinBp, SegmentProd, SegmentProdBp, SegmentSum, SegmentSumBp, Select, SeluBp, SequenceMask, Shape, ShapeN, ShiftBits, SigmoidCrossEntropyLoss, SigmoidCrossEntropyLossBp, SigmoidDerivative, Size, SizeAt, SkipGramRound, Slice, SliceBp, SoftMax, SoftmaxBp, SoftmaxCrossEntropyLoss, SoftmaxCrossEntropyLossBp, SoftmaxCrossEntropyWithLogitsLoss, SoftmaxCrossEntropyWithLogitsLossBp, SoftPlusBp, SoftSignBp, SpaceToBatch, SpaceToBatchND, SpaceToDepth, SparseSoftmaxCrossEntropyLossWithLogits, SparseSoftmaxCrossEntropyLossWithLogitsBp, Split, SplitV, SpTreeCell, SquaredDifferenceBpOp, SquaredDifferenceOp, SquaredNormBp, Squeeze, SRU, SRUCell, Stack, StandardDeviationBp, Standardize, StandardizeBp, StopGradient, StridedSlice, StridedSliceBp, SubBpOp, SubOp, SufficientStatistics, SumBp, Svd, Switch, TanhDerivative, TensorArray, TensorArrayConcat, TensorArrayGather, TensorArrayRead, TensorArrayScatter, TensorArraySize, TensorArraySplit, TensorArrayWrite, TensorMmul, ThresholdRelu, ThresholdReluBp, Tile, TileBp, TopK, Trace, Transpose, TruncateDivOp, Unique, UniqueWithCounts, UnsortedSegmentMax, UnsortedSegmentMaxBp, UnsortedSegmentMean, UnsortedSegmentMeanBp, UnsortedSegmentMin, UnsortedSegmentMinBp, UnsortedSegmentProd, UnsortedSegmentProdBp, UnsortedSegmentSqrtN, UnsortedSegmentSqrtNBp, UnsortedSegmentSum, UnsortedSegmentSumBp, Unstack, Upsampling2d, Upsampling2dDerivative, VarianceBp, WeightedCrossEntropyLoss, Where, WhereNumpy, While, WhileDerivative, XwPlusB, ZeroFraction, ZerosLike, Zeta
```
public interface CustomOp
```
This interface describe "custom operations. Originally these operations are designed for SameDiff, and execution within graph, but we also want to provide option to use them with regular ND4J methods via NativeOpExecutioner

Author:

[email protected]

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBArgument(boolean... arg)`
`void`	`addIArgument(int... arg)`
`void`	`addIArgument(long... 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`
`boolean[]`	`bArgs()`
`List<LongShapeDescriptor>`	`calculateOutputShape()` Calculate the output shape for this op
`Boolean`	`getBArgument(int index)`
`CustomOpDescriptor`	`getDescriptor()` Get the custom op descriptor if one is available.
`Long`	`getIArgument(int index)`
`INDArray`	`getInputArgument(int index)`
`INDArray`	`getOutputArgument(int index)`
`Double`	`getTArgument(int index)`
`long[]`	`iArgs()`
`INDArray[]`	`inputArguments()`
`boolean`	`isInplaceCall()` This method returns true if op is supposed to be executed inplace
`int`	`numBArguments()`
`int`	`numIArguments()`
`int`	`numInputArguments()`
`int`	`numOutputArguments()`
`int`	`numTArguments()`
`long`	`opHash()` This method returns LongHash of the opName()
`String`	`opName()` This method returns op opName as string
`INDArray[]`	`outputArguments()`
`void`	`removeIArgument(Integer arg)`
`void`	`removeInputArgument(INDArray arg)`
`void`	`removeOutputArgument(INDArray arg)`
`void`	`removeTArgument(Double arg)`
`double[]`	`tArgs()`

Method Detail

opName
```
String opName()
```
This method returns op opName as string

Returns:

opHash
```
long opHash()
```
This method returns LongHash of the opName()

Returns:

isInplaceCall
```
boolean isInplaceCall()
```
This method returns true if op is supposed to be executed inplace

Returns:

outputArguments
```
INDArray[] outputArguments()
```

inputArguments
```
INDArray[] inputArguments()
```

iArgs
```
long[] iArgs()
```

tArgs
```
double[] tArgs()
```

bArgs
```
boolean[] bArgs()
```

addIArgument
```
void addIArgument(int... arg)
```

addIArgument
```
void addIArgument(long... arg)
```

addBArgument
```
void addBArgument(boolean... arg)
```

removeIArgument
```
void removeIArgument(Integer arg)
```

getBArgument
```
Boolean getBArgument(int index)
```

getIArgument
```
Long getIArgument(int index)
```

numIArguments
```
int numIArguments()
```

addTArgument
```
void addTArgument(double... arg)
```

removeTArgument
```
void removeTArgument(Double arg)
```

getTArgument
```
Double getTArgument(int index)
```

numTArguments
```
int numTArguments()
```

numBArguments
```
int numBArguments()
```

addInputArgument

void addInputArgument(INDArray... arg)

removeInputArgument

void removeInputArgument(INDArray arg)

getInputArgument
```
INDArray getInputArgument(int index)
```

numInputArguments
```
int numInputArguments()
```

addOutputArgument

void addOutputArgument(INDArray... arg)

removeOutputArgument

void removeOutputArgument(INDArray arg)

getOutputArgument
```
INDArray getOutputArgument(int index)
```

numOutputArguments
```
int numOutputArguments()
```

calculateOutputShape
```
List<LongShapeDescriptor> calculateOutputShape()
```
Calculate the output shape for this op

Returns:

getDescriptor
```
CustomOpDescriptor getDescriptor()
```
Get the custom op descriptor if one is available.

Returns:

assertValidForExecution
```
void assertValidForExecution()
```
Asserts a valid state for execution, otherwise throws an ND4JIllegalStateException

Interface CustomOp

Method Summary

Method Detail

opName

opHash

isInplaceCall

outputArguments

inputArguments

iArgs

tArgs

bArgs

addIArgument

addIArgument

addBArgument

removeIArgument

getBArgument

getIArgument

numIArguments

addTArgument

removeTArgument

getTArgument

numTArguments

numBArguments

addInputArgument

removeInputArgument

getInputArgument

numInputArguments

addOutputArgument

removeOutputArgument

getOutputArgument

numOutputArguments

calculateOutputShape

getDescriptor

assertValidForExecution