Package org.nd4j.linalg.lossfunctions

Enum LossFunctions.LossFunction

java.lang.Object

java.lang.Enum<LossFunctions.LossFunction>

org.nd4j.linalg.lossfunctions.LossFunctions.LossFunction

All Implemented Interfaces:

Serializable, Comparable<LossFunctions.LossFunction>

Enclosing class:

LossFunctions

public static enum LossFunctions.LossFunction
extends Enum<LossFunctions.LossFunction>

MSE: Mean Squared Error: Linear Regression - LossMSE
l1: L1 loss (absolute value) - LossL1
XENT: Cross Entropy: Binary Classification - LossBinaryXENT
MCXENT: Multiclass Cross Entropy - LossMCXENT
SPARSE_MCXENT: Sparse multi-class cross entropy - LossSparseMCXENT
SQUARED_LOSS: Alias for mean squared error - LossMSE
NEGATIVELOGLIKELIHOOD: Negative Log Likelihood - LossNegativeLogLikelihood
COSINE_PROXIMITY: Cosine proximity loss - LossCosineProximity
HINGE: Hinge loss - LossHinge
SQUARED_HINGE: Squared hinge loss - LossSquaredHinge
KL_DIVERGENCE: Kullback-Leibler divergence loss - LossKLD
MEAN_ABSOLUTE_ERROR: mean absolute error loss - LossMAE
L2: L2 loss (sum of squared errors) - LossL2
MEAN_ABSOLUTE_PERCENTAGE_ERROR: MAPE loss - LossMAPE
MEAN_SQUARED_LOGARITHMIC_ERROR: MSLE loss - LossMSLE
POISSON: Poisson loss - LossPoisson
WASSERSTEIN: Wasserstein loss - LossWasserstein

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE_PROXIMITY
HINGE
KL_DIVERGENCE
L1
L2
MCXENT
MEAN_ABSOLUTE_ERROR
MEAN_ABSOLUTE_PERCENTAGE_ERROR
MEAN_SQUARED_LOGARITHMIC_ERROR
MSE
NEGATIVELOGLIKELIHOOD
POISSON
RECONSTRUCTION_CROSSENTROPY
SPARSE_MCXENT
SQUARED_HINGE
SQUARED_LOSS
WASSERSTEIN
XENT

Method Summary

Modifier and Type	Method	Description
ILossFunction	getILossFunction()
static LossFunctions.LossFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LossFunctions.LossFunction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MSE

public static final LossFunctions.LossFunction MSE

L1

public static final LossFunctions.LossFunction L1

XENT

public static final LossFunctions.LossFunction XENT

MCXENT

public static final LossFunctions.LossFunction MCXENT

SPARSE_MCXENT

public static final LossFunctions.LossFunction SPARSE_MCXENT

SQUARED_LOSS

public static final LossFunctions.LossFunction SQUARED_LOSS

RECONSTRUCTION_CROSSENTROPY

public static final LossFunctions.LossFunction RECONSTRUCTION_CROSSENTROPY

NEGATIVELOGLIKELIHOOD

public static final LossFunctions.LossFunction NEGATIVELOGLIKELIHOOD

COSINE_PROXIMITY

public static final LossFunctions.LossFunction COSINE_PROXIMITY

HINGE

public static final LossFunctions.LossFunction HINGE

SQUARED_HINGE

public static final LossFunctions.LossFunction SQUARED_HINGE

KL_DIVERGENCE

public static final LossFunctions.LossFunction KL_DIVERGENCE

MEAN_ABSOLUTE_ERROR

public static final LossFunctions.LossFunction MEAN_ABSOLUTE_ERROR

L2

public static final LossFunctions.LossFunction L2

MEAN_ABSOLUTE_PERCENTAGE_ERROR

public static final LossFunctions.LossFunction MEAN_ABSOLUTE_PERCENTAGE_ERROR

MEAN_SQUARED_LOGARITHMIC_ERROR

public static final LossFunctions.LossFunction MEAN_SQUARED_LOGARITHMIC_ERROR

POISSON

public static final LossFunctions.LossFunction POISSON

WASSERSTEIN

public static final LossFunctions.LossFunction WASSERSTEIN

Method Detail

values

public static LossFunctions.LossFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LossFunctions.LossFunction c : LossFunctions.LossFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LossFunctions.LossFunction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getILossFunction

public ILossFunction getILossFunction()