org.deeplearning4j.ui.stats

Class StatsListener

java.lang.Object

org.deeplearning4j.ui.stats.BaseStatsListener

org.deeplearning4j.ui.stats.StatsListener

All Implemented Interfaces:

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

public class StatsListener
extends BaseStatsListener

StatsListener: a general purpose listener for collecting and reporting system and model information.

Stats are collected and passed on to a StatsStorageRouter - for example, for storage and/or displaying in the UI, use InMemoryStatsStorage or FileStatsStorage.

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields inherited from class org.deeplearning4j.ui.stats.BaseStatsListener

TYPE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StatsListener	clone()
StatsInitializationReport	getNewInitializationReport()
StatsReport	getNewStatsReport()
StorageMetaData	getNewStorageMetaData(long initTime, String sessionID, String workerID)

Methods inherited from class org.deeplearning4j.ui.stats.BaseStatsListener

getInitConfig, getSessionID, getStorageRouter, getUpdateConfig, getWorkerID, iterationDone, onBackwardPass, onEpochEnd, onEpochStart, onForwardPass, onForwardPass, onGradientCalculation, setSessionID, setStorageRouter, setUpdateConfig, setWorkerID

Methods inherited from class java.lang.Object

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

Constructor Detail

StatsListener

public StatsListener(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

StatsListener

public StatsListener(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

StatsListener

public StatsListener(StatsStorageRouter router,
                     int listenerFrequency,
                     String sessionId)

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

sessionId - The Session ID for storing the stats, optional (may be null)

StatsListener

public StatsListener(StatsStorageRouter router,
                     StatsInitializationConfiguration initConfig,
                     StatsUpdateConfiguration updateConfig,
                     String sessionID,
                     String workerID)

Method Detail

clone

public StatsListener clone()

Specified by:

clone in interface RoutingIterationListener

Specified by:

clone in class BaseStatsListener

getNewInitializationReport

public StatsInitializationReport getNewInitializationReport()

Specified by:

getNewInitializationReport in class BaseStatsListener

getNewStatsReport

public StatsReport getNewStatsReport()

Specified by:

getNewStatsReport in class BaseStatsListener

getNewStorageMetaData

public StorageMetaData getNewStorageMetaData(long initTime,
                                             String sessionID,
                                             String workerID)

Specified by:

getNewStorageMetaData in class BaseStatsListener