org.nd4j.linalg.api.ops.impl.accum

Class Entropy

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

org.nd4j.linalg.api.ops.impl.accum.Entropy

All Implemented Interfaces:

Accumulation, Op

public class Entropy
extends BaseAccumulation

Entropy Op - returns the entropy (information gain, or uncertainty of a random variable). -sum(x * log(x))

Author:

raver119@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.ops.Op

Op.Type

Field Summary

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

finalResult, isComplex, keepDims, newFormat

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

extraArgs, extraArgz, n, numProcessed, passThrough, x, xVertexId, y, yVertexId, z, zVertexId

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

dimensions, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
Entropy()
Entropy(INDArray x)
Entropy(INDArray x, INDArray y)
Entropy(INDArray x, INDArray y, INDArray z)
Entropy(INDArray x, INDArray y, INDArray z, long n)
Entropy(INDArray x, INDArray y, long n)
Entropy(SameDiff sameDiff, SDVariable i_v, int[] dimensions)

Method Summary

Modifier and Type	Method and Description
List<SDVariable>	doDiff(List<SDVariable> f1) The actual implementation for automatic differentiation.
Op.Type	getOpType()
static List<SDVariable>	grad(DifferentialFunctionFactory f, SDVariable arg, SDVariable grad, int[] dimensions)
String	onnxName() The opName of this function in onnx
String	opName() The name of the op
int	opNum() The number of the op (mainly for old legacy XYZ ops like Op)
String	tensorflowName() The opName of this function tensorflow

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

calculateOutputShape, getFinalResult, hasReductionIndices, initFromOnnx, initFromTensorFlow, isComplexAccumulation, isKeepDims, noOp, opType, setFinalResult, zeroDouble, zeroFloat, zeroHalf

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

equals, exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, hashCode, init, isExecSpecial, isPassThrough, n, numProcessed, outputVariables, setN, setX, setY, setZ, toCustomOp, toString, x, y, z

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

arg, arg, argNames, args, asProperties, attributeAdaptersForFunction, configFieldName, diff, dup, f, getNumOutputs, getValue, hasPlaceHolderInputs, isConfigProperties, larg, mappingsForFunction, onnxNames, outputVariable, outputVariables, outputVariablesNames, 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.Op

exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, init, isExecSpecial, isPassThrough, n, numProcessed, setExtraArgs, setN, setX, setY, setZ, toCustomOp, x, y, z

Constructor Detail

Entropy

public Entropy(SameDiff sameDiff,
               SDVariable i_v,
               int[] dimensions)

Entropy

public Entropy()

Entropy

public Entropy(INDArray x,
               INDArray y,
               INDArray z,
               long n)

Entropy

public Entropy(INDArray x,
               INDArray y,
               long n)

Entropy

public Entropy(INDArray x)

Entropy

public Entropy(INDArray x,
               INDArray y)

Entropy

public Entropy(INDArray x,
               INDArray y,
               INDArray z)

Method Detail

opNum

public int opNum()

Description copied from class: DifferentialFunction

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

Specified by:

opNum in interface Op

Overrides:

opNum in class DifferentialFunction

Returns:

opName

public String opName()

Description copied from class: DifferentialFunction

The name of the op

Specified by:

opName in interface Op

Overrides:

opName in class DifferentialFunction

Returns:

the opName of this operation

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:

getOpType

public Op.Type getOpType()

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:

grad

public static List<SDVariable> grad(DifferentialFunctionFactory f,
                                    SDVariable arg,
                                    SDVariable grad,
                                    int[] dimensions)