org.deeplearning4j.ui.stats

Class BaseStatsListener

java.lang.Object

org.deeplearning4j.ui.stats.BaseStatsListener

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, RoutingIterationListener, IterationListener, TrainingListener

Direct Known Subclasses:

J7StatsListener, StatsListener

public abstract class BaseStatsListener
extends java.lang.Object
implements RoutingIterationListener

BaseStatsListener: a general purpose listener for collecting and reporting system and model information. Serves as a base for different ways of storing the collected data

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_ID

Constructor Summary

Constructors

Constructor and Description
BaseStatsListener(StatsStorageRouter router) Create a StatsListener with network information collected at every iteration.
BaseStatsListener(StatsStorageRouter router, int listenerFrequency) Create a StatsListener with network information collected every n >= 1 time steps
BaseStatsListener(StatsStorageRouter router, StatsInitializationConfiguration initConfig, StatsUpdateConfiguration updateConfig, java.lang.String sessionID, java.lang.String workerID)

Method Summary

Modifier and Type	Method and Description
abstract BaseStatsListener	clone()
StatsInitializationConfiguration	getInitConfig()
abstract StatsInitializationReport	getNewInitializationReport()
abstract StatsReport	getNewStatsReport()
abstract StorageMetaData	getNewStorageMetaData(long initTime, java.lang.String sessionID, java.lang.String workerID)
java.lang.String	getSessionID()
StatsStorageRouter	getStorageRouter()
StatsUpdateConfiguration	getUpdateConfig()
java.lang.String	getWorkerID()
void	invoke() Change invoke to true
boolean	invoked() Get if listener invoked
void	iterationDone(Model model, int iteration) Event listener for each iteration
void	onBackwardPass(Model model) Called once per iteration (backward pass) after gradients have been calculated, and updated Gradients are available via Model.gradient().
void	onEpochEnd(Model model) Called once at the end of each epoch, when using methods such as MultiLayerNetwork.fit(DataSetIterator), ComputationGraph.fit(DataSetIterator) or ComputationGraph.fit(MultiDataSetIterator)
void	onEpochStart(Model model) Called once at the start of each epoch, when using methods such as MultiLayerNetwork.fit(DataSetIterator), ComputationGraph.fit(DataSetIterator) or ComputationGraph.fit(MultiDataSetIterator)
void	onForwardPass(Model model, java.util.List<org.nd4j.linalg.api.ndarray.INDArray> activations) Called once per iteration (forward pass) for activations (usually for a MultiLayerNetwork), only at training time
void	onForwardPass(Model model, java.util.Map<java.lang.String,org.nd4j.linalg.api.ndarray.INDArray> activations) Called once per iteration (forward pass) for activations (usually for a ComputationGraph), only at training time
void	onGradientCalculation(Model model) Called once per iteration (backward pass) before the gradients are updated Gradients are available via Model.gradient().
void	setSessionID(java.lang.String sessionID)
void	setStorageRouter(StatsStorageRouter router)
void	setUpdateConfig(StatsUpdateConfiguration newConfig)
void	setWorkerID(java.lang.String workerID)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ID

public static final java.lang.String TYPE_ID

See Also:

Constant Field Values

Constructor Detail

BaseStatsListener

public BaseStatsListener(StatsStorageRouter router)

Create a StatsListener with network information collected at every iteration. Equivalent to #StatsListener(StatsStorageRouter, int) with listenerFrequency == 1

Parameters:

router - Where/how to store the calculated stats. For example, InMemoryStatsStorage or FileStatsStorage

BaseStatsListener

public BaseStatsListener(StatsStorageRouter router,
                         int listenerFrequency)

Create a StatsListener with network information collected every n >= 1 time steps

Parameters:

router - Where/how to store the calculated stats. For example, InMemoryStatsStorage or FileStatsStorage

listenerFrequency - Frequency with which to collect stats information

BaseStatsListener

public BaseStatsListener(StatsStorageRouter router,
                         StatsInitializationConfiguration initConfig,
                         StatsUpdateConfiguration updateConfig,
                         java.lang.String sessionID,
                         java.lang.String workerID)

Method Detail

getNewInitializationReport

public abstract StatsInitializationReport getNewInitializationReport()

getNewStatsReport

public abstract StatsReport getNewStatsReport()

getNewStorageMetaData

public abstract StorageMetaData getNewStorageMetaData(long initTime,
                                                      java.lang.String sessionID,
                                                      java.lang.String workerID)

getInitConfig

public StatsInitializationConfiguration getInitConfig()

getUpdateConfig

public StatsUpdateConfiguration getUpdateConfig()

setUpdateConfig

public void setUpdateConfig(StatsUpdateConfiguration newConfig)

setStorageRouter

public void setStorageRouter(StatsStorageRouter router)

Specified by:

setStorageRouter in interface RoutingIterationListener

getStorageRouter

public StatsStorageRouter getStorageRouter()

Specified by:

getStorageRouter in interface RoutingIterationListener

setWorkerID

public void setWorkerID(java.lang.String workerID)

Specified by:

setWorkerID in interface RoutingIterationListener

getWorkerID

public java.lang.String getWorkerID()

Specified by:

getWorkerID in interface RoutingIterationListener

setSessionID

public void setSessionID(java.lang.String sessionID)

Specified by:

setSessionID in interface RoutingIterationListener

getSessionID

public java.lang.String getSessionID()

Specified by:

getSessionID in interface RoutingIterationListener

invoked

public boolean invoked()

Description copied from interface: IterationListener

Get if listener invoked

Specified by:

invoked in interface IterationListener

invoke

public void invoke()

Description copied from interface: IterationListener

Change invoke to true

Specified by:

invoke in interface IterationListener

onEpochStart

public void onEpochStart(Model model)

Description copied from interface: TrainingListener

Called once at the start of each epoch, when using methods such as MultiLayerNetwork.fit(DataSetIterator), ComputationGraph.fit(DataSetIterator) or ComputationGraph.fit(MultiDataSetIterator)

Specified by:

onEpochStart in interface TrainingListener

onEpochEnd

public void onEpochEnd(Model model)

Description copied from interface: TrainingListener

Called once at the end of each epoch, when using methods such as MultiLayerNetwork.fit(DataSetIterator), ComputationGraph.fit(DataSetIterator) or ComputationGraph.fit(MultiDataSetIterator)

Specified by:

onEpochEnd in interface TrainingListener

onForwardPass

public void onForwardPass(Model model,
                          java.util.List<org.nd4j.linalg.api.ndarray.INDArray> activations)

Description copied from interface: TrainingListener

Called once per iteration (forward pass) for activations (usually for a MultiLayerNetwork), only at training time

Specified by:

onForwardPass in interface TrainingListener

Parameters:

model - Model

activations - Layer activations (including input)

onForwardPass

public void onForwardPass(Model model,
                          java.util.Map<java.lang.String,org.nd4j.linalg.api.ndarray.INDArray> activations)

Description copied from interface: TrainingListener

Called once per iteration (forward pass) for activations (usually for a ComputationGraph), only at training time

Specified by:

onForwardPass in interface TrainingListener

Parameters:

model - Model

activations - Layer activations (including input)

onGradientCalculation

public void onGradientCalculation(Model model)

Description copied from interface: TrainingListener

Called once per iteration (backward pass) before the gradients are updated Gradients are available via Model.gradient(). Note that gradients will likely be updated in-place - thus they should be copied or processed synchronously in this method.

For updates (gradients post learning rate/momentum/rmsprop etc) see TrainingListener.onBackwardPass(Model)

Specified by:

onGradientCalculation in interface TrainingListener

Parameters:

model - Model

onBackwardPass

public void onBackwardPass(Model model)

Description copied from interface: TrainingListener

Called once per iteration (backward pass) after gradients have been calculated, and updated Gradients are available via Model.gradient().

Unlike TrainingListener.onGradientCalculation(Model) the gradients at this point will be post-update, rather than raw (pre-update) gradients at that method call.

Specified by:

onBackwardPass in interface TrainingListener

Parameters:

model - Model

iterationDone

public void iterationDone(Model model,
                          int iteration)

Description copied from interface: IterationListener

Event listener for each iteration

Specified by:

iterationDone in interface IterationListener

Parameters:

model - the model iterating

iteration - the iteration

clone

public abstract BaseStatsListener clone()

Specified by:

clone in interface RoutingIterationListener

Overrides:

clone in class java.lang.Object