org.deeplearning4j.ui.stats

Class BaseStatsListener

java.lang.Object

org.deeplearning4j.ui.stats.BaseStatsListener

All Implemented Interfaces:

Serializable, Cloneable, RoutingIterationListener, org.deeplearning4j.optimize.api.TrainingListener

Direct Known Subclasses:

J7StatsListener, StatsListener

public abstract class BaseStatsListener
extends 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

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static 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, String sessionID, 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, String sessionID, String workerID)
String	getSessionID()
StatsStorageRouter	getStorageRouter()
StatsUpdateConfiguration	getUpdateConfig()
String	getWorkerID()
void	iterationDone(org.deeplearning4j.nn.api.Model model, int iteration, int epoch)
void	onBackwardPass(org.deeplearning4j.nn.api.Model model)
void	onEpochEnd(org.deeplearning4j.nn.api.Model model)
void	onEpochStart(org.deeplearning4j.nn.api.Model model)
void	onForwardPass(org.deeplearning4j.nn.api.Model model, List<INDArray> activations)
void	onForwardPass(org.deeplearning4j.nn.api.Model model, Map<String,INDArray> activations)
void	onGradientCalculation(org.deeplearning4j.nn.api.Model model)
void	setSessionID(String sessionID)
void	setStorageRouter(StatsStorageRouter router)
void	setUpdateConfig(StatsUpdateConfiguration newConfig)
void	setWorkerID(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 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.

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,
                         String sessionID,
                         String workerID)

Method Detail

getNewInitializationReport

public abstract StatsInitializationReport getNewInitializationReport()

getNewStatsReport

public abstract StatsReport getNewStatsReport()

getNewStorageMetaData

public abstract StorageMetaData getNewStorageMetaData(long initTime,
                                                      String sessionID,
                                                      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(String workerID)

Specified by:

setWorkerID in interface RoutingIterationListener

getWorkerID

public String getWorkerID()

Specified by:

getWorkerID in interface RoutingIterationListener

setSessionID

public void setSessionID(String sessionID)

Specified by:

setSessionID in interface RoutingIterationListener

getSessionID

public String getSessionID()

Specified by:

getSessionID in interface RoutingIterationListener

onEpochStart

public void onEpochStart(org.deeplearning4j.nn.api.Model model)

Specified by:

onEpochStart in interface org.deeplearning4j.optimize.api.TrainingListener

onEpochEnd

public void onEpochEnd(org.deeplearning4j.nn.api.Model model)

Specified by:

onEpochEnd in interface org.deeplearning4j.optimize.api.TrainingListener

onForwardPass

public void onForwardPass(org.deeplearning4j.nn.api.Model model,
                          List<INDArray> activations)

Specified by:

onForwardPass in interface org.deeplearning4j.optimize.api.TrainingListener

onForwardPass

public void onForwardPass(org.deeplearning4j.nn.api.Model model,
                          Map<String,INDArray> activations)

Specified by:

onForwardPass in interface org.deeplearning4j.optimize.api.TrainingListener

onGradientCalculation

public void onGradientCalculation(org.deeplearning4j.nn.api.Model model)

Specified by:

onGradientCalculation in interface org.deeplearning4j.optimize.api.TrainingListener

onBackwardPass

public void onBackwardPass(org.deeplearning4j.nn.api.Model model)

Specified by:

onBackwardPass in interface org.deeplearning4j.optimize.api.TrainingListener

iterationDone

public void iterationDone(org.deeplearning4j.nn.api.Model model,
                          int iteration,
                          int epoch)

Specified by:

iterationDone in interface org.deeplearning4j.optimize.api.TrainingListener

clone

public abstract BaseStatsListener clone()

Specified by:

clone in interface RoutingIterationListener

Overrides:

clone in class Object