smile.classification

Enum NeuralNetwork.ActivationFunction

java.lang.Object

java.lang.Enum<NeuralNetwork.ActivationFunction>

smile.classification.NeuralNetwork.ActivationFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NeuralNetwork.ActivationFunction>

Enclosing class:

NeuralNetwork

public static enum NeuralNetwork.ActivationFunction
extends java.lang.Enum<NeuralNetwork.ActivationFunction>

The types of activation functions in output layer. In this implementation, the hidden layers always employs logistic sigmoid activation function.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINEAR Linear activation function.
LOGISTIC_SIGMOID Logistic sigmoid activation function.
SOFTMAX Softmax activation for multi-class cross entropy objection function.

Method Summary

Modifier and Type	Method and Description
static NeuralNetwork.ActivationFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NeuralNetwork.ActivationFunction[]	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

LINEAR

public static final NeuralNetwork.ActivationFunction LINEAR

Linear activation function.

LOGISTIC_SIGMOID

public static final NeuralNetwork.ActivationFunction LOGISTIC_SIGMOID

Logistic sigmoid activation function. For multi-class classification, each unit in output layer corresponds to a class. For binary classification and cross entropy error function, there is only one output unit whose value can be regarded as posteriori probability.

SOFTMAX

public static final NeuralNetwork.ActivationFunction SOFTMAX

Softmax activation for multi-class cross entropy objection function. The values of units in output layer can be regarded as posteriori probabilities of each class.

Method Detail

values

public static NeuralNetwork.ActivationFunction[] 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 (NeuralNetwork.ActivationFunction c : NeuralNetwork.ActivationFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static NeuralNetwork.ActivationFunction valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null