Package com.logicaldoc.ai.neural

Enum Class LossFunction

java.lang.Object

java.lang.Enum<LossFunction>

com.logicaldoc.ai.neural.LossFunction

All Implemented Interfaces:

Serializable, Comparable<LossFunction>, Constable

public enum LossFunction
extends Enum<LossFunction>

The available loss functions for the neural network losses calculation.

• MSE: Mean Squared Error: Linear Regression
• XENT: Cross Entropy: Binary Classification
• MCXENT: Multiclass Cross Entropy
• SQUARED_LOSS: Squared Loss
• NEGATIVELOGLIKELIHOOD: Negative Log Likelihood

Since:

9.2

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MCXENT
MSE
NEGATIVELOGLIKELIHOOD
SQUARED_LOSS
XENT

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MSE

public static final LossFunction MSE

XENT

public static final LossFunction XENT

MCXENT

public static final LossFunction MCXENT

SQUARED_LOSS

public static final LossFunction SQUARED_LOSS

NEGATIVELOGLIKELIHOOD

public static final LossFunction NEGATIVELOGLIKELIHOOD

Method Details

values

public static LossFunction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LossFunction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null