Package deepnetts.net.train

Enum Class TrainingEvent.Type

java.lang.Object

java.lang.Enum<TrainingEvent.Type>

deepnetts.net.train.TrainingEvent.Type

All Implemented Interfaces:

Serializable, Comparable<TrainingEvent.Type>, Constable

Enclosing class:

TrainingEvent

public static enum TrainingEvent.Type
extends Enum<TrainingEvent.Type>

Type of a training event.

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
EPOCH_FINISHED	Specifies a training epoch finished event
EPOCH_STARTED	Specifies a training epoch started event
ITERATION_FINISHED	Specifies a training iteration for (single data item) finished event
MINI_BATCH	Specifies a mini batch (batch of items) finished event
STARTED	Specifies a training started event
STOPPED	Specifies a training stopped event

Method Summary

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

STARTED

public static final TrainingEvent.Type STARTED

Specifies a training started event

STOPPED

public static final TrainingEvent.Type STOPPED

Specifies a training stopped event

EPOCH_STARTED

public static final TrainingEvent.Type EPOCH_STARTED

Specifies a training epoch started event

EPOCH_FINISHED

public static final TrainingEvent.Type EPOCH_FINISHED

Specifies a training epoch finished event

MINI_BATCH

public static final TrainingEvent.Type MINI_BATCH

Specifies a mini batch (batch of items) finished event

ITERATION_FINISHED

public static final TrainingEvent.Type ITERATION_FINISHED

Specifies a training iteration for (single data item) finished event

Method Details

values

public static TrainingEvent.Type[] 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 TrainingEvent.Type 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