Package org.nd4j.linalg.api.ops.impl.reduce.bp

Class BaseReductionBp

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.DynamicCustomOp

org.nd4j.linalg.api.ops.impl.reduce.bp.BaseReductionBp

All Implemented Interfaces:

CustomOp

Direct Known Subclasses:

CumProdBp, CumSumBp, DotBp, MaxBp, MeanBp, MinBp, Norm1Bp, Norm2Bp, NormMaxBp, ProdBp, SquaredNormBp, StandardDeviationBp, SumBp, VarianceBp

public abstract class BaseReductionBp
extends DynamicCustomOp

Nested Class Summary

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

DynamicCustomOp.DynamicCustomOpsBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected int[]	dimensions
protected boolean	keepDims

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

extraArgs, inPlace, ownName, ownNameSetWithDefault, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor	Description
BaseReductionBp(SameDiff sameDiff, SDVariable origInput, SDVariable gradAtOutput, boolean keepDims, int... dimensions)
BaseReductionBp(SameDiff sameDiff, SDVariable origInput, SDVariable gradAtOutput, boolean keepDims, SDVariable dimensions)
BaseReductionBp(SameDiff sameDiff, SDVariable origInput1, SDVariable origInput2, SDVariable gradAtOutput, boolean keepDims, int... dimensions)
BaseReductionBp(INDArray origInput, INDArray gradAtOutput, INDArray output, boolean keepDims, int... dimensions)
BaseReductionBp(INDArray origInput, INDArray gradAtOutput, INDArray output, boolean keepDims, INDArray dimensions)
BaseReductionBp(INDArray origInput1, INDArray origInput2, INDArray gradAtOutput, INDArray output, boolean keepDims, int... dimensions)
BaseReductionBp(INDArray origInput1, INDArray origInput2, INDArray gradAtOutput, INDArray output1, INDArray output2, boolean keepDims, int... dimensions)

Method Summary

Modifier and Type	Method	Description
protected void	addArgs()
List<DataType>	calculateOutputDataTypes(List<DataType> dataTypes)	Calculate the data types for the output arrays.
abstract String	opName()	This method returns op opName as string

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, configureFromArguments, dArgs, doDiff, generateFake, generateFake, getBArgument, getDescriptor, getIArgument, getInputArgument, getOutputArgument, getSArgument, getTArgument, getValue, iArgs, initFromOnnx, initFromTensorFlow, 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, setPropertiesForFunction, 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

Field Detail

keepDims

protected boolean keepDims

dimensions

protected int[] dimensions

Constructor Detail

BaseReductionBp

public BaseReductionBp(SameDiff sameDiff,
                       SDVariable origInput,
                       SDVariable gradAtOutput,
                       boolean keepDims,
                       int... dimensions)

Parameters:

origInput - Pre-reduced input

gradAtOutput - Gradient at the output

keepDims - If true: reduction dimensions were kept

dimensions - Dimensions to reduce. May be null

BaseReductionBp

public BaseReductionBp(SameDiff sameDiff,
                       SDVariable origInput1,
                       SDVariable origInput2,
                       SDVariable gradAtOutput,
                       boolean keepDims,
                       int... dimensions)

Parameters:

origInput1 - Pre-reduced input 1

origInput2 - Pre-reduced input 2

gradAtOutput - Gradient at the output

keepDims - If true: reduction dimensions were kept

dimensions - Dimensions to reduce. May be null

BaseReductionBp

public BaseReductionBp(INDArray origInput,
                       INDArray gradAtOutput,
                       INDArray output,
                       boolean keepDims,
                       int... dimensions)

Parameters:

origInput - Pre-reduced input

gradAtOutput - Gradient at the output

output - Output array - i.e., gradient at the input to the reduction function

keepDims - If true: reduction dimensions were kept

dimensions - Dimensions to reduce. May be null

BaseReductionBp

public BaseReductionBp(INDArray origInput1,
                       INDArray origInput2,
                       INDArray gradAtOutput,
                       INDArray output,
                       boolean keepDims,
                       int... dimensions)

Parameters:

origInput1 - Pre-reduced input1

origInput2 - Pre-reduced input2

gradAtOutput - Gradient at the output

output - Output array - i.e., gradient at the input to the reduction function

keepDims - If true: reduction dimensions were kept

dimensions - Dimensions to reduce. May be null

BaseReductionBp

public BaseReductionBp(INDArray origInput1,
                       INDArray origInput2,
                       INDArray gradAtOutput,
                       INDArray output1,
                       INDArray output2,
                       boolean keepDims,
                       int... dimensions)

BaseReductionBp

public BaseReductionBp(INDArray origInput,
                       INDArray gradAtOutput,
                       INDArray output,
                       boolean keepDims,
                       INDArray dimensions)

BaseReductionBp

public BaseReductionBp(SameDiff sameDiff,
                       SDVariable origInput,
                       SDVariable gradAtOutput,
                       boolean keepDims,
                       SDVariable dimensions)

Method Detail

addArgs

protected void addArgs()

opName

public abstract 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:

calculateOutputDataTypes

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

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:

dataTypes - The data types of the inputs

Returns:

The data types of the outputs