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

Class SoftMax

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseTransformOp

org.nd4j.linalg.api.ops.impl.transforms.SoftMax

All Implemented Interfaces:

Op, TransformOp

Direct Known Subclasses:

SoftMaxDerivative

public class SoftMax
extends BaseTransformOp

Soft max function row_maxes is a row vector (max for each row) row_maxes = rowmaxes(input) diff = exp(input - max) / diff.rowSums() Outputs a probability distribution. Note that this is a parameterized model and requires the sum and max for the vector being calculated

Author:

Adam Gibson

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.BaseOp

extraArgs, n, numProcessed, passThrough, x, y, z

Constructor Summary

Constructors

Constructor and Description
SoftMax()
SoftMax(INDArray x)
SoftMax(INDArray x, INDArray z)
SoftMax(INDArray x, INDArray y, INDArray z)
SoftMax(INDArray x, INDArray y, INDArray z, long n)
SoftMax(INDArray x, INDArray z, long n)

Method Summary

Modifier and Type	Method and Description
TransformOp	derivative() The derivative operation for this op
void	exec() Execute the op if its pass through (not needed most of the time)
void	exec(int... dimensions) Exec along each dimension
void	init(INDArray x, INDArray y, INDArray z, long n) Initialize the operation based on the parameters
boolean	isExecSpecial() Whether the executioner needs to do a special call or not
String	name() The name of this operation
double	op(double origin) Transform an individual element
double	op(double origin, double other) Pairwise op (applicable with an individual element in y)
float	op(float origin) Transform an individual element
float	op(float origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin) Transform an individual element
IComplexNumber	op(IComplexNumber origin, double other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, IComplexNumber other) Pairwise op (applicable with an individual element in y)
Op	opForDimension(int index, int... dimension) A copy of this operation for a particular dimension of the input
Op	opForDimension(int index, int dimension) A copy of this operation for a particular dimension of the input
int	opNum() An op number

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

extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, isPassThrough, n, numProcessed, setN, setX, setY, setZ, toString, x, y, z

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

extraArgs, extraArgsBuff, extraArgsDataBuff, isPassThrough, n, numProcessed, setN, setX, setY, setZ, x, y, z

Constructor Detail

SoftMax

public SoftMax()

SoftMax

public SoftMax(INDArray x,
               INDArray z)

SoftMax

public SoftMax(INDArray x,
               INDArray z,
               long n)

SoftMax

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

SoftMax

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

SoftMax

public SoftMax(INDArray x)

Method Detail

opNum

public int opNum()

Description copied from interface: Op

An op number

Returns:

isExecSpecial

public boolean isExecSpecial()

Description copied from interface: Op

Whether the executioner needs to do a special call or not

Specified by:

isExecSpecial in interface Op

Overrides:

isExecSpecial in class BaseOp

Returns:

true if the executioner needs to do a special call or not false otherwise

name

public String name()

Description copied from interface: Op

The name of this operation

Returns:

the name of this operation

op

public IComplexNumber op(IComplexNumber origin,
                         double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         IComplexNumber other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public float op(float origin,
                float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin,
                 double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public float op(float origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public IComplexNumber op(IComplexNumber origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

derivative

public TransformOp derivative()

Description copied from interface: TransformOp

The derivative operation for this op

Specified by:

derivative in interface TransformOp

Overrides:

derivative in class BaseTransformOp

Returns:

the derivative operation for this op's inputs

opForDimension

public Op opForDimension(int index,
                         int dimension)

Description copied from interface: Op

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

opForDimension

public Op opForDimension(int index,
                         int... dimension)

Description copied from interface: Op

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

exec

public void exec()

Description copied from interface: Op

Execute the op if its pass through (not needed most of the time)

Specified by:

exec in interface Op

Overrides:

exec in class BaseOp

init

public void init(INDArray x,
                 INDArray y,
                 INDArray z,
                 long n)

Description copied from interface: Op

Initialize the operation based on the parameters

Specified by:

init in interface Op

Overrides:

init in class BaseOp

Parameters:

x - the input

y - the pairwise transform ndarray

z - the resulting ndarray

n - the number of elements

exec

public void exec(int... dimensions)

Description copied from interface: Op

Exec along each dimension

Specified by:

exec in interface Op

Overrides:

exec in class BaseOp

Parameters:

dimensions - the dimensions to execute on