org.deeplearning4j.ui.stats.impl.java

Class JavaStatsReport

java.lang.Object

org.deeplearning4j.ui.stats.impl.java.JavaStatsReport

All Implemented Interfaces:

java.io.Serializable, Persistable, StatsReport

public class JavaStatsReport
extends java.lang.Object
implements StatsReport

Created by Alex on 14/12/2016.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JavaStatsReport()

Method Summary

Modifier and Type	Method and Description
void	decode(byte[] decode) Decode the content of the given byte array in to this persistable
void	decode(java.nio.ByteBuffer buffer) Decode from the given ByteBuffer
void	decode(java.io.InputStream inputStream) Decode from the given input stream
byte[]	encode()
void	encode(java.nio.ByteBuffer buffer) Encode this persistable in to a ByteBuffer
void	encode(java.io.OutputStream outputStream) Encode this persistable in to an output stream
int	encodingLengthBytes() Length of the encoding, in bytes, when using Persistable.encode() Length may be different using Persistable.encode(OutputStream), due to things like stream headers
java.util.List<java.io.Serializable>	getDataSetMetaData() Get the DataSet metadata, if any (null otherwise).
java.lang.String	getDataSetMetaDataClassName() Get the class
java.util.List<Pair<java.lang.String,int[]>>	getGarbageCollectionStats() Get the garbage collection stats: Pair contains GC name and the delta count/time values
java.util.Map<java.lang.String,Histogram>	getHistograms(StatsType statsType) Get the histograms for all parameters, for a given StatsType (Parameters/Updates/Activations)
java.util.Map<java.lang.String,java.lang.Double>	getLearningRates() Get the learning rates by parameter
java.util.Map<java.lang.String,java.lang.Double>	getMean(StatsType statsType) Get the mean values for each parameter for the given StatsType (Parameters/Updates/Activations)
java.util.Map<java.lang.String,java.lang.Double>	getMeanMagnitudes(StatsType statsType) Get the mean magnitude values for each parameter for the given StatsType (Parameters/Updates/Activations)
java.util.Map<java.lang.String,java.lang.Double>	getStdev(StatsType statsType) Get the standard deviation values for each parameter for the given StatsType (Parameters/Updates/Activations)
boolean	hasDataSetMetaData() Return whether any DataSet metadata is present or not
boolean	hasGarbageCollection() Return whether garbage collection information has been reported
boolean	hasHistograms(StatsType statsType) Return whether histograms have been reported, for the given stats type (Parameters, Updates, Activations)
boolean	hasLearningRates() Return whether the learning rates are present (have been reported)
boolean	hasMemoryUse() Return whether memory use has been reported
boolean	hasPerformance() Return whether performance stats (total time, total examples etc) have been reported
boolean	hasScore() Return whether the score is present (has been reported)
boolean	hasSummaryStats(StatsType statsType, SummaryType summaryType) Return whether the summary stats (mean, standard deviation, mean magnitudes) have been reported for the given stats type (Parameters, Updates, Activations)
void	reportDataSetMetaData(java.util.List<java.io.Serializable> dataSetMetaData, java.lang.Class<?> metaDataClass) Report any metadata for the DataSet
void	reportDataSetMetaData(java.util.List<java.io.Serializable> dataSetMetaData, java.lang.String metaDataClass) Report any metadata for the DataSet
void	reportGarbageCollection(java.lang.String gcName, int deltaGCCount, int deltaGCTime) Report Garbage collection stats
void	reportHistograms(StatsType statsType, java.util.Map<java.lang.String,Histogram> histogram) Report histograms for all parameters, for a given StatsType
void	reportIDs(java.lang.String sessionID, java.lang.String typeID, java.lang.String workerID, long timeStamp)
void	reportIterationCount(int iterationCount) Report the current iteration number
void	reportLearningRates(java.util.Map<java.lang.String,java.lang.Double> learningRatesByParam) Report the learning rates by parameter
void	reportMean(StatsType statsType, java.util.Map<java.lang.String,java.lang.Double> mean) Report the mean values for each parameter, the given StatsType (Parameters/Updates/Activations)
void	reportMeanMagnitudes(StatsType statsType, java.util.Map<java.lang.String,java.lang.Double> meanMagnitudes) Report the mean magnitude values for each parameter for the given StatsType (Parameters/Updates/Activations)
void	reportMemoryUse(long jvmCurrentBytes, long jvmMaxBytes, long offHeapCurrentBytes, long offHeapMaxBytes, long[] deviceCurrentBytes, long[] deviceMaxBytes) Report the memory stats at this iteration
void	reportPerformance(long totalRuntimeMs, long totalExamples, long totalMinibatches, double examplesPerSecond, double minibatchesPerSecond) Report the performance stats (since the last report)
void	reportScore(double currentScore) Report model score at the current iteration
void	reportStatsCollectionDurationMS(int statsCollectionDurationMS) Report the number of milliseconds required to calculate all of the stats.
void	reportStdev(StatsType statsType, java.util.Map<java.lang.String,java.lang.Double> stdev) Report the standard deviation values for each parameter for the given StatsType (Parameters/Updates/Activations)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deeplearning4j.ui.stats.api.StatsReport

getDeviceCurrentBytes, getDeviceMaxBytes, getExamplesPerSecond, getIterationCount, getJvmCurrentBytes, getJvmMaxBytes, getMinibatchesPerSecond, getOffHeapCurrentBytes, getOffHeapMaxBytes, getScore, getStatsCollectionDurationMs, getTotalExamples, getTotalMinibatches, getTotalRuntimeMs

Methods inherited from interface org.deeplearning4j.api.storage.Persistable

getSessionID, getTimeStamp, getTypeID, getWorkerID

Constructor Detail

JavaStatsReport

public JavaStatsReport()

Method Detail

reportIDs

public void reportIDs(java.lang.String sessionID,
                      java.lang.String typeID,
                      java.lang.String workerID,
                      long timeStamp)

Specified by:

reportIDs in interface StatsReport

reportIterationCount

public void reportIterationCount(int iterationCount)

Description copied from interface: StatsReport

Report the current iteration number

Specified by:

reportIterationCount in interface StatsReport

reportStatsCollectionDurationMS

public void reportStatsCollectionDurationMS(int statsCollectionDurationMS)

Description copied from interface: StatsReport

Report the number of milliseconds required to calculate all of the stats. This is effectively the amount of listener overhead

Specified by:

reportStatsCollectionDurationMS in interface StatsReport

reportScore

public void reportScore(double currentScore)

Description copied from interface: StatsReport

Report model score at the current iteration

Specified by:

reportScore in interface StatsReport

reportLearningRates

public void reportLearningRates(java.util.Map<java.lang.String,java.lang.Double> learningRatesByParam)

Description copied from interface: StatsReport

Report the learning rates by parameter

Specified by:

reportLearningRates in interface StatsReport

reportMemoryUse

public void reportMemoryUse(long jvmCurrentBytes,
                            long jvmMaxBytes,
                            long offHeapCurrentBytes,
                            long offHeapMaxBytes,
                            long[] deviceCurrentBytes,
                            long[] deviceMaxBytes)

Description copied from interface: StatsReport

Report the memory stats at this iteration

Specified by:

reportMemoryUse in interface StatsReport

Parameters:

jvmCurrentBytes - Current bytes used by the JVM

jvmMaxBytes - Max bytes usable by the JVM (heap)

offHeapCurrentBytes - Current off-heap bytes used

offHeapMaxBytes - Maximum off-heap bytes

deviceCurrentBytes - Current bytes used by each device (GPU, etc). May be null if no devices are present

deviceMaxBytes - Maximum bytes for each device (GPU, etc). May be null if no devices are present

reportPerformance

public void reportPerformance(long totalRuntimeMs,
                              long totalExamples,
                              long totalMinibatches,
                              double examplesPerSecond,
                              double minibatchesPerSecond)

Description copied from interface: StatsReport

Report the performance stats (since the last report)

Specified by:

reportPerformance in interface StatsReport

Parameters:

totalRuntimeMs - Overall runtime since initialization

totalExamples - Total examples processed since initialization

totalMinibatches - Total number of minibatches (iterations) since initialization

examplesPerSecond - Examples per second since last report

minibatchesPerSecond - Minibatches per second since last report

reportGarbageCollection

public void reportGarbageCollection(java.lang.String gcName,
                                    int deltaGCCount,
                                    int deltaGCTime)

Description copied from interface: StatsReport

Report Garbage collection stats

Specified by:

reportGarbageCollection in interface StatsReport

Parameters:

gcName - Garbage collector name

deltaGCCount - Change in the total number of garbage collections, since last report

deltaGCTime - Change in the amount of time (milliseconds) for garbage collection, since last report

getGarbageCollectionStats

public java.util.List<Pair<java.lang.String,int[]>> getGarbageCollectionStats()

Description copied from interface: StatsReport

Get the garbage collection stats: Pair contains GC name and the delta count/time values

Specified by:

getGarbageCollectionStats in interface StatsReport

reportHistograms

public void reportHistograms(StatsType statsType,
                             java.util.Map<java.lang.String,Histogram> histogram)

Description copied from interface: StatsReport

Report histograms for all parameters, for a given StatsType

Specified by:

reportHistograms in interface StatsReport

Parameters:

statsType - StatsType: Parameters, Updates, Activations

histogram - Histogram values for all parameters

getHistograms

public java.util.Map<java.lang.String,Histogram> getHistograms(StatsType statsType)

Description copied from interface: StatsReport

Get the histograms for all parameters, for a given StatsType (Parameters/Updates/Activations)

Specified by:

getHistograms in interface StatsReport

Parameters:

statsType - Stats type (Params/updatse/activations) to get histograms for

Returns:

Histograms by parameter name, or null if not available

reportMean

public void reportMean(StatsType statsType,
                       java.util.Map<java.lang.String,java.lang.Double> mean)

Description copied from interface: StatsReport

Report the mean values for each parameter, the given StatsType (Parameters/Updates/Activations)

Specified by:

reportMean in interface StatsReport

Parameters:

statsType - Stats type to report

mean - Map of mean values, by parameter

getMean

public java.util.Map<java.lang.String,java.lang.Double> getMean(StatsType statsType)

Description copied from interface: StatsReport

Get the mean values for each parameter for the given StatsType (Parameters/Updates/Activations)

Specified by:

getMean in interface StatsReport

Parameters:

statsType - Stats type to get mean values for

Returns:

Map of mean values by parameter

reportStdev

public void reportStdev(StatsType statsType,
                        java.util.Map<java.lang.String,java.lang.Double> stdev)

Description copied from interface: StatsReport

Report the standard deviation values for each parameter for the given StatsType (Parameters/Updates/Activations)

Specified by:

reportStdev in interface StatsReport

Parameters:

statsType - Stats type to report std. dev values for

stdev - Map of std dev values by parameter

getStdev

public java.util.Map<java.lang.String,java.lang.Double> getStdev(StatsType statsType)

Description copied from interface: StatsReport

Get the standard deviation values for each parameter for the given StatsType (Parameters/Updates/Activations)

Specified by:

getStdev in interface StatsReport

Parameters:

statsType - Stats type to get std dev values for

Returns:

Map of stdev values by parameter

reportMeanMagnitudes

public void reportMeanMagnitudes(StatsType statsType,
                                 java.util.Map<java.lang.String,java.lang.Double> meanMagnitudes)

Description copied from interface: StatsReport

Report the mean magnitude values for each parameter for the given StatsType (Parameters/Updates/Activations)

Specified by:

reportMeanMagnitudes in interface StatsReport

Parameters:

statsType - Stats type to report mean magnitude values for

meanMagnitudes - Map of mean magnitude values by parameter

reportDataSetMetaData

public void reportDataSetMetaData(java.util.List<java.io.Serializable> dataSetMetaData,
                                  java.lang.Class<?> metaDataClass)

Description copied from interface: StatsReport

Report any metadata for the DataSet

Specified by:

reportDataSetMetaData in interface StatsReport

Parameters:

dataSetMetaData - MetaData for the DataSet

metaDataClass - Class of the metadata. Can be later retieved using StatsReport.getDataSetMetaDataClassName()

reportDataSetMetaData

public void reportDataSetMetaData(java.util.List<java.io.Serializable> dataSetMetaData,
                                  java.lang.String metaDataClass)

Description copied from interface: StatsReport

Report any metadata for the DataSet

Specified by:

reportDataSetMetaData in interface StatsReport

Parameters:

dataSetMetaData - MetaData for the DataSet

metaDataClass - Class of the metadata. Can be later retieved using StatsReport.getDataSetMetaDataClassName()

getMeanMagnitudes

public java.util.Map<java.lang.String,java.lang.Double> getMeanMagnitudes(StatsType statsType)

Description copied from interface: StatsReport

Get the mean magnitude values for each parameter for the given StatsType (Parameters/Updates/Activations)

Specified by:

getMeanMagnitudes in interface StatsReport

Parameters:

statsType - Stats type to get mean magnitude values for

Returns:

Map of mean magnitude values by parameter

getDataSetMetaData

public java.util.List<java.io.Serializable> getDataSetMetaData()

Description copied from interface: StatsReport

Get the DataSet metadata, if any (null otherwise). Note: due to serialization issues, this may in principle throw an unchecked exception related to class availability, serialization etc.

Specified by:

getDataSetMetaData in interface StatsReport

Returns:

List of DataSet metadata, if any.

getDataSetMetaDataClassName

public java.lang.String getDataSetMetaDataClassName()

Description copied from interface: StatsReport

Get the class

Specified by:

getDataSetMetaDataClassName in interface StatsReport

Returns:

getLearningRates

public java.util.Map<java.lang.String,java.lang.Double> getLearningRates()

Description copied from interface: StatsReport

Get the learning rates by parameter

Specified by:

getLearningRates in interface StatsReport

hasScore

public boolean hasScore()

Description copied from interface: StatsReport

Return whether the score is present (has been reported)

Specified by:

hasScore in interface StatsReport

hasLearningRates

public boolean hasLearningRates()

Description copied from interface: StatsReport

Return whether the learning rates are present (have been reported)

Specified by:

hasLearningRates in interface StatsReport

hasMemoryUse

public boolean hasMemoryUse()

Description copied from interface: StatsReport

Return whether memory use has been reported

Specified by:

hasMemoryUse in interface StatsReport

hasPerformance

public boolean hasPerformance()

Description copied from interface: StatsReport

Return whether performance stats (total time, total examples etc) have been reported

Specified by:

hasPerformance in interface StatsReport

hasGarbageCollection

public boolean hasGarbageCollection()

Description copied from interface: StatsReport

Return whether garbage collection information has been reported

Specified by:

hasGarbageCollection in interface StatsReport

hasHistograms

public boolean hasHistograms(StatsType statsType)

Description copied from interface: StatsReport

Return whether histograms have been reported, for the given stats type (Parameters, Updates, Activations)

Specified by:

hasHistograms in interface StatsReport

Parameters:

statsType - Stats type

hasSummaryStats

public boolean hasSummaryStats(StatsType statsType,
                               SummaryType summaryType)

Description copied from interface: StatsReport

Return whether the summary stats (mean, standard deviation, mean magnitudes) have been reported for the given stats type (Parameters, Updates, Activations)

Specified by:

hasSummaryStats in interface StatsReport

Parameters:

statsType - stats type (Parameters, Updates, Activations)

summaryType - Summary statistic type (mean, stdev, mean magnitude)

hasDataSetMetaData

public boolean hasDataSetMetaData()

Description copied from interface: StatsReport

Return whether any DataSet metadata is present or not

Specified by:

hasDataSetMetaData in interface StatsReport

Returns:

True if DataSet metadata is present

encodingLengthBytes

public int encodingLengthBytes()

Description copied from interface: Persistable

Length of the encoding, in bytes, when using Persistable.encode() Length may be different using Persistable.encode(OutputStream), due to things like stream headers

Specified by:

encodingLengthBytes in interface Persistable

Returns:

encode

public byte[] encode()

Specified by:

encode in interface Persistable

encode

public void encode(java.nio.ByteBuffer buffer)

Description copied from interface: Persistable

Encode this persistable in to a ByteBuffer

Specified by:

encode in interface Persistable

encode

public void encode(java.io.OutputStream outputStream)
            throws java.io.IOException

Description copied from interface: Persistable

Encode this persistable in to an output stream

Specified by:

encode in interface Persistable

Throws:

java.io.IOException

decode

public void decode(byte[] decode)

Description copied from interface: Persistable

Decode the content of the given byte array in to this persistable

Specified by:

decode in interface Persistable

decode

public void decode(java.nio.ByteBuffer buffer)

Description copied from interface: Persistable

Decode from the given ByteBuffer

Specified by:

decode in interface Persistable

decode

public void decode(java.io.InputStream inputStream)
            throws java.io.IOException

Description copied from interface: Persistable

Decode from the given input stream

Specified by:

decode in interface Persistable

Throws:

java.io.IOException