Class TrainingEvent

java.lang.Object

deepnetts.net.train.TrainingEvent

public final class TrainingEvent
extends Object

TrainingEvent is used to notify interested parties that training event has happened. It contains a type and a source of the event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TrainingEvent.Type	Type of a training event.

Field Summary

Fields

Modifier and Type	Field	Description
static TrainingEvent.Type	EPOCH_FINISHED	Specifies that training epoch has finished.
static TrainingEvent.Type	EPOCH_STARTED	Specifies that training epoch has started.
static TrainingEvent.Type	ITERATION_FINISHED	Specifies that training iteration has finished.
static TrainingEvent.Type	MINI_BATCH	Specifies mini batch event.
static TrainingEvent.Type	STARTED	Specifies that training has started.
static TrainingEvent.Type	STOPPED	Specifies that training has stopped.

Constructor Summary

Constructors

Constructor	Description
TrainingEvent(BackpropagationTrainer source, TrainingEvent.Type type)	Constructs a new TrainingEvent with specified source and type.

Method Summary

Modifier and Type	Method	Description
BackpropagationTrainer	getSource()	Gets the source of the event.
TrainingEvent.Type	getType()	Gets the type of the event.

Methods inherited from class Object

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

Field Details

STARTED

public static TrainingEvent.Type STARTED

Specifies that training has started.

STOPPED

public static TrainingEvent.Type STOPPED

Specifies that training has stopped.

EPOCH_STARTED

public static TrainingEvent.Type EPOCH_STARTED

Specifies that training epoch has started.

EPOCH_FINISHED

public static TrainingEvent.Type EPOCH_FINISHED

Specifies that training epoch has finished.

MINI_BATCH

public static TrainingEvent.Type MINI_BATCH

Specifies mini batch event.

ITERATION_FINISHED

public static TrainingEvent.Type ITERATION_FINISHED

Specifies that training iteration has finished.

Constructor Details

TrainingEvent

public TrainingEvent(BackpropagationTrainer source,
 TrainingEvent.Type type)

Constructs a new TrainingEvent with specified source and type.

Parameters:

source - source of the event, typically some training algorithm

type - type of the event

Method Details

getSource

public BackpropagationTrainer getSource()

Gets the source of the event. Usually the source of the event is some training algorithm.

Returns:

the source of the event.

getType

public TrainingEvent.Type getType()

Gets the type of the event.

Returns:

the type of the event