Package org.nd4j.linalg.api.ops.impl.transforms.clip

Class ClipByNorm

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.DynamicCustomOp

org.nd4j.linalg.api.ops.impl.transforms.clip.ClipByNorm

All Implemented Interfaces:

CustomOp

public class ClipByNorm
extends DynamicCustomOp

Nested Class Summary

Nested classes/interfaces inherited from class org.nd4j.linalg.api.ops.DynamicCustomOp

DynamicCustomOp.DynamicCustomOpsBuilder

Field Summary

Fields inherited from class org.nd4j.linalg.api.ops.DynamicCustomOp

axis, bArguments, dArguments, iArguments, inplaceCall, inputArguments, outputArguments, outputVariables, sArguments, tArguments

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

dimensions, extraArgs, inPlace, ownName, ownNameSetWithDefault, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor	Description
ClipByNorm()
ClipByNorm(SameDiff sameDiff, SDVariable x, double clipValue, int... dimensions)
ClipByNorm(SameDiff sd, SDVariable x, SDVariable clipValue, SDVariable dimensions)
ClipByNorm(INDArray in, double clipValue, int... dimensions)
ClipByNorm(INDArray in, INDArray out, double clipValue, int... dimensions)
ClipByNorm(INDArray x, INDArray clipValue, INDArray dimensions)

Method Summary

Modifier and Type	Method	Description
List<DataType>	calculateOutputDataTypes(List<DataType> inputDataTypes)	Calculate the data types for the output arrays.
void	configureFromArguments()	This allows a custom op to configure relevant fields from its arguments.
List<SDVariable>	doDiff(List<SDVariable> grad)	The actual implementation for automatic differentiation.
void	initFromOnnx(Onnx.NodeProto node, SameDiff initWith, Map<String,Onnx.AttributeProto> attributesForNode, Onnx.GraphProto graph)	Iniitialize the function from the given Onnx.NodeProto
void	initFromTensorFlow(NodeDef nodeDef, SameDiff initWith, Map<String,AttrValue> attributesForNode, GraphDef graph)	Initialize the function from the given NodeDef
String	opName()	This method returns op opName as string
void	setPropertiesForFunction(Map<String,Object> properties)

Methods inherited from class org.nd4j.linalg.api.ops.DynamicCustomOp

addBArgument, addDArgument, addIArgument, addIArgument, addInputArgument, addOutputArgument, addOutputsToOp, addSArgument, addTArgument, assertValidForExecution, bArgs, builder, calculateOutputShape, calculateOutputShape, clearArrays, computeArrays, dArgs, generateFake, generateFake, getBArgument, getDescriptor, getIArgument, getInputArgument, getOutputArgument, getSArgument, getTArgument, getValue, iArgs, inputArguments, mappingsForFunction, numBArguments, numDArguments, numIArguments, numInputArguments, numOutputArguments, numSArguments, numTArguments, onnxName, opHash, opNum, opType, outputArguments, outputVariables, outputVariables, propertiesForFunction, removeIArgument, removeInputArgument, removeOutputArgument, removeSArgument, removeTArgument, sArgs, setInputArgument, setInputArguments, setOutputArgument, setValueFor, tArgs, tensorflowName, toString, wrapFilterNull, wrapOrNull, wrapOrNull

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

arg, arg, argNames, args, attributeAdaptersForFunction, configFieldName, configureWithSameDiff, diff, dup, equals, getBooleanFromProperty, getDoubleValueFromProperty, getIntValueFromProperty, getLongValueFromProperty, getNumOutputs, getStringFromProperty, hashCode, isConfigProperties, larg, onnxNames, outputs, outputVariable, outputVariablesNames, rarg, replaceArg, setInstanceId, 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

Constructor Detail

ClipByNorm

public ClipByNorm()

ClipByNorm

public ClipByNorm(SameDiff sameDiff,
                  SDVariable x,
                  double clipValue,
                  int... dimensions)

ClipByNorm

public ClipByNorm(INDArray in,
                  double clipValue,
                  int... dimensions)

ClipByNorm

public ClipByNorm(INDArray in,
                  INDArray out,
                  double clipValue,
                  int... dimensions)

ClipByNorm

public ClipByNorm(SameDiff sd,
                  SDVariable x,
                  SDVariable clipValue,
                  SDVariable dimensions)

ClipByNorm

public ClipByNorm(INDArray x,
                  INDArray clipValue,
                  INDArray dimensions)

Method Detail

opName

public String opName()

Description copied from class: DynamicCustomOp

This method returns op opName as string

Specified by:

opName in interface CustomOp

Overrides:

opName in class DynamicCustomOp

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

Overrides:

initFromTensorFlow in class DynamicCustomOp

initFromOnnx

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

Description copied from class: DifferentialFunction

Iniitialize the function from the given Onnx.NodeProto

Overrides:

initFromOnnx in class DynamicCustomOp

setPropertiesForFunction

public void setPropertiesForFunction(Map<String,Object> properties)

Overrides:

setPropertiesForFunction in class DynamicCustomOp

configureFromArguments

public void configureFromArguments()

Description copied from interface: CustomOp

This allows a custom op to configure relevant fields from its arguments. This is needed when ops are created via reflection for things like model import.

Specified by:

configureFromArguments in interface CustomOp

Overrides:

configureFromArguments in class DynamicCustomOp

doDiff

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

Description copied from class: DifferentialFunction

The actual implementation for automatic differentiation.

Overrides:

doDiff in class DynamicCustomOp

Returns:

calculateOutputDataTypes

public List<DataType> calculateOutputDataTypes(List<DataType> inputDataTypes)

Description copied from class: DifferentialFunction

Calculate the data types for the output arrays. Though datatypes can also be inferred from DifferentialFunction.calculateOutputShape(), this method differs in that it does not require the input arrays to be populated. This is important as it allows us to do greedy datatype inference for the entire net - even if arrays are not available.

Overrides:

calculateOutputDataTypes in class DifferentialFunction

Parameters:

inputDataTypes - The data types of the inputs

Returns:

The data types of the outputs