org.deeplearning4j.ui.stats.api

Interface StatsInitializationReport

All Superinterfaces:

Persistable, Serializable

All Known Implementing Classes:

JavaStatsInitializationReport, SbeStatsInitializationReport

public interface StatsInitializationReport
extends Persistable

An interface used with StatsListener for reporting static information. The idea is that this information will be reported only once, at the first call of the StatsListener. Comparatively, the StatsReport will be used multiple times - every N iterations according to the configuration (StatsUpdateConfiguration).

Note that the software, hardware and model information may or may not be obtained and reported, depending on the configuration provided by the relevant StatsInitializationConfiguration

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
String[]	getHwDeviceDescription()
long[]	getHwDeviceTotalMemory()
String	getHwHardwareUID()
int	getHwJvmAvailableProcessors()
long	getHwJvmMaxMemory()
int	getHwNumDevices()
long	getHwOffHeapMaxMemory()
String	getModelClassName()
String	getModelConfigJson()
int	getModelNumLayers()
long	getModelNumParams()
String[]	getModelParamNames()
String	getSwArch()
Map<String,String>	getSwEnvironmentInfo()
String	getSwHostName()
String	getSwJvmName()
String	getSwJvmSpecVersion()
String	getSwJvmUID()
String	getSwJvmVersion()
String	getSwNd4jBackendClass()
String	getSwNd4jDataTypeName()
String	getSwOsName()
boolean	hasHardwareInfo()
boolean	hasModelInfo()
boolean	hasSoftwareInfo()
void	reportHardwareInfo(int jvmAvailableProcessors, int numDevices, long jvmMaxMemory, long offHeapMaxMemory, long[] deviceTotalMemory, String[] deviceDescription, String hardwareUID)
void	reportIDs(String sessionID, String typeID, String workerID, long timestamp)
void	reportModelInfo(String modelClassName, String modelConfigJson, String[] paramNames, int numLayers, long numParams) Report the model information
void	reportSoftwareInfo(String arch, String osName, String jvmName, String jvmVersion, String jvmSpecVersion, String nd4jBackendClass, String nd4jDataTypeName, String hostname, String jvmUID, Map<String,String> swEnvironmentInfo)

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

decode, decode, decode, encode, encode, encode, encodingLengthBytes, getSessionID, getTimeStamp, getTypeID, getWorkerID

Method Detail

reportIDs

void reportIDs(String sessionID,
               String typeID,
               String workerID,
               long timestamp)

reportSoftwareInfo

void reportSoftwareInfo(String arch,
                        String osName,
                        String jvmName,
                        String jvmVersion,
                        String jvmSpecVersion,
                        String nd4jBackendClass,
                        String nd4jDataTypeName,
                        String hostname,
                        String jvmUID,
                        Map<String,String> swEnvironmentInfo)

Parameters:

arch - Operating system architecture, as reported by JVM

osName - Operating system name

jvmName - JVM name

jvmVersion - JVM version

jvmSpecVersion - JVM Specification version (for example, 1.8)

nd4jBackendClass - ND4J backend Factory class

nd4jDataTypeName - ND4J datatype name

hostname - Hostname for the machine, if available

jvmUID - A unique identified for the current JVM. Should be shared by all instances in the same JVM. Should vary for different JVMs on the same machine.

swEnvironmentInfo - Environment information: Usually from Nd4j.getExecutioner().getEnvironmentInformation()

reportHardwareInfo

void reportHardwareInfo(int jvmAvailableProcessors,
                        int numDevices,
                        long jvmMaxMemory,
                        long offHeapMaxMemory,
                        long[] deviceTotalMemory,
                        String[] deviceDescription,
                        String hardwareUID)

Parameters:

jvmAvailableProcessors - Number of available processor cores according to the JVM

numDevices - Number of compute devices (GPUs)

jvmMaxMemory - Maximum memory for the JVM

offHeapMaxMemory - Maximum off-heap memory

deviceTotalMemory - GPU memory by device: same length as numDevices. May be null, if numDevices is 0

deviceDescription - Description of each device. May be null, if numDevices is 0

hardwareUID - A unique identifier for the machine. Should be shared by all instances running on the same machine, including in different JVMs

reportModelInfo

void reportModelInfo(String modelClassName,
                     String modelConfigJson,
                     String[] paramNames,
                     int numLayers,
                     long numParams)

Report the model information

Parameters:

modelClassName - Model class name: i.e., type of model

modelConfigJson - Model configuration, as JSON string

numLayers - Number of layers in the model

numParams - Number of parameters in the model

hasSoftwareInfo

boolean hasSoftwareInfo()

hasHardwareInfo

boolean hasHardwareInfo()

hasModelInfo

boolean hasModelInfo()

getSwArch

String getSwArch()

getSwOsName

String getSwOsName()

getSwJvmName

String getSwJvmName()

getSwJvmVersion

String getSwJvmVersion()

getSwJvmSpecVersion

String getSwJvmSpecVersion()

getSwNd4jBackendClass

String getSwNd4jBackendClass()

getSwNd4jDataTypeName

String getSwNd4jDataTypeName()

getSwHostName

String getSwHostName()

getSwJvmUID

String getSwJvmUID()

getSwEnvironmentInfo

Map<String,String> getSwEnvironmentInfo()

getHwJvmAvailableProcessors

int getHwJvmAvailableProcessors()

getHwNumDevices

int getHwNumDevices()

getHwJvmMaxMemory

long getHwJvmMaxMemory()

getHwOffHeapMaxMemory

long getHwOffHeapMaxMemory()

getHwDeviceTotalMemory

long[] getHwDeviceTotalMemory()

getHwDeviceDescription

String[] getHwDeviceDescription()

getHwHardwareUID

String getHwHardwareUID()

getModelClassName

String getModelClassName()

getModelConfigJson

String getModelConfigJson()

getModelParamNames

String[] getModelParamNames()

getModelNumLayers

int getModelNumLayers()

getModelNumParams

long getModelNumParams()