Package org.nd4j.linalg.api.ops.impl.reduce3

Class CosineSimilarity

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseReduceOp

org.nd4j.linalg.api.ops.BaseReduceFloatOp

org.nd4j.linalg.api.ops.impl.reduce3.BaseReduce3Op

org.nd4j.linalg.api.ops.impl.reduce3.CosineSimilarity

All Implemented Interfaces:

Op, ReduceFloatOp, ReduceOp

public class CosineSimilarity
extends BaseReduce3Op

Nested Class Summary

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

Op.Type

Field Summary

Fields

Modifier and Type	Field	Description
static String	OP_NAME

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

dimensionVariable, isComplex, isEmptyReduce, keepDims

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

dimensionz, extraArgz, x, xVertexId, y, yVertexId, z, zVertexId

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

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

Constructor Summary

Constructors

Constructor	Description
CosineSimilarity()
CosineSimilarity(SameDiff sameDiff, SDVariable i_v, int[] dimensions)
CosineSimilarity(SameDiff sameDiff, SDVariable i_v, SDVariable dimensions)
CosineSimilarity(SameDiff sd, SDVariable x, SDVariable y, boolean keepDims, boolean isComplex, int[] dimensions)
CosineSimilarity(SameDiff sameDiff, SDVariable i_v, SDVariable i_v2, int[] dimensions)
CosineSimilarity(SameDiff sameDiff, SDVariable i_v, SDVariable i_v2, SDVariable dimensions)
CosineSimilarity(INDArray x, INDArray y, boolean keepDims, boolean isComplex, int[] dimensions)
CosineSimilarity(INDArray x, INDArray y, boolean allDistances, int... dimension)
CosineSimilarity(INDArray x, INDArray y, int... dimensions)
CosineSimilarity(INDArray x, INDArray y, INDArray z)
CosineSimilarity(INDArray x, INDArray y, INDArray z, boolean keepDims, boolean allDistances, int... dimensions)
CosineSimilarity(INDArray x, INDArray y, INDArray z, boolean allDistances, int... dimension)
CosineSimilarity(INDArray x, INDArray y, INDArray z, int... dimensions)

Method Summary

Modifier and Type	Method	Description
List<SDVariable>	doDiff(List<SDVariable> i_v1)	The actual implementation for automatic differentiation.
static List<SDVariable>	doDiff(SameDiff sameDiff, SDVariable x, SDVariable y, SDVariable gradOut, boolean keepDims, int... dimensions)
String	opName()	The name of the op
int	opNum()	The number of the op (mainly for old legacy XYZ ops like Op)

Methods inherited from class org.nd4j.linalg.api.ops.impl.reduce3.BaseReduce3Op

calculateOutputDataTypes, getOpType, onnxName, opType, resultType, tensorflowName

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

calculateOutputShape, calculateOutputShape, resultType, validateDataTypes

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

configureWithSameDiff, hasReductionIndices, initFromOnnx, initFromTensorFlow, isComplexAccumulation, isKeepDims, noOp, setDimensions, setPropertiesForFunction

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

clearArrays, computeVariables, defineDimensions, dimensions, equals, extraArgs, extraArgsBuff, extraArgsDataBuff, getFinalResult, getInputArgument, getNumOutputs, getOpType, hashCode, outputVariables, setX, setY, setZ, toCustomOp, toString, x, y, z

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

arg, arg, argNames, args, attributeAdaptersForFunction, configFieldName, diff, dup, getBooleanFromProperty, getDoubleValueFromProperty, getIntValueFromProperty, getLongValueFromProperty, getStringFromProperty, getValue, isConfigProperties, larg, mappingsForFunction, onnxNames, outputs, outputVariable, outputVariables, outputVariablesNames, propertiesForFunction, rarg, replaceArg, 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

clearArrays, extraArgs, extraArgsBuff, extraArgsDataBuff, setExtraArgs, setX, setY, setZ, toCustomOp, x, y, z

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

dimensions, getFinalResult, isComplexAccumulation, isKeepDims, noOp, setDimensions

Field Detail

OP_NAME

public static final String OP_NAME

See Also:

Constant Field Values

Constructor Detail

CosineSimilarity

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

CosineSimilarity

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

CosineSimilarity

public CosineSimilarity(SameDiff sameDiff,
                        SDVariable i_v,
                        SDVariable dimensions)

CosineSimilarity

public CosineSimilarity(SameDiff sameDiff,
                        SDVariable i_v,
                        SDVariable i_v2,
                        SDVariable dimensions)

CosineSimilarity

public CosineSimilarity()

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        INDArray z,
                        int... dimensions)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        int... dimensions)

CosineSimilarity

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

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        INDArray z,
                        boolean allDistances,
                        int... dimension)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        boolean allDistances,
                        int... dimension)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        INDArray z,
                        boolean keepDims,
                        boolean allDistances,
                        int... dimensions)

CosineSimilarity

public CosineSimilarity(SameDiff sd,
                        SDVariable x,
                        SDVariable y,
                        boolean keepDims,
                        boolean isComplex,
                        int[] dimensions)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        boolean keepDims,
                        boolean isComplex,
                        int[] dimensions)

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

doDiff

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

Description copied from class: DifferentialFunction

The actual implementation for automatic differentiation.

Specified by:

doDiff in class DifferentialFunction

Returns:

doDiff

public static List<SDVariable> doDiff(SameDiff sameDiff,
                                      SDVariable x,
                                      SDVariable y,
                                      SDVariable gradOut,
                                      boolean keepDims,
                                      int... dimensions)