org.deeplearning4j.ui.stats.impl

Class SbeStatsInitializationReport

java.lang.Object

org.deeplearning4j.ui.stats.impl.SbeStatsInitializationReport

All Implemented Interfaces:

java.io.Serializable, Persistable, StatsInitializationReport, AgronaPersistable

public class SbeStatsInitializationReport
extends java.lang.Object
implements StatsInitializationReport, AgronaPersistable

An implementation of StatsInitializationReport using Simple Binary Encoding (SBE)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SbeStatsInitializationReport()

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(org.agrona.DirectBuffer buffer)
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(org.agrona.MutableDirectBuffer buffer)
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.lang.String	getSessionID() Get the session id
long	getTimeStamp() Get when this was created.
java.lang.String	getTypeID() Get the type id
java.lang.String	getWorkerID() Get the worker id
boolean	hasHardwareInfo()
boolean	hasModelInfo()
boolean	hasSoftwareInfo()
void	reportHardwareInfo(int jvmAvailableProcessors, int numDevices, long jvmMaxMemory, long offHeapMaxMemory, long[] deviceTotalMemory, java.lang.String[] deviceDescription, java.lang.String hardwareUID)
void	reportIDs(java.lang.String sessionID, java.lang.String typeID, java.lang.String workerID, long timeStamp)
void	reportModelInfo(java.lang.String modelClassName, java.lang.String modelConfigJson, java.lang.String[] modelParamNames, int numLayers, long numParams) Report the model information
void	reportSoftwareInfo(java.lang.String arch, java.lang.String osName, java.lang.String jvmName, java.lang.String jvmVersion, java.lang.String jvmSpecVersion, java.lang.String nd4jBackendClass, java.lang.String nd4jDataTypeName, java.lang.String hostname, java.lang.String jvmUid, java.util.Map<java.lang.String,java.lang.String> swEnvironmentInfo)

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.StatsInitializationReport

getHwDeviceDescription, getHwDeviceTotalMemory, getHwHardwareUID, getHwJvmAvailableProcessors, getHwJvmMaxMemory, getHwNumDevices, getHwOffHeapMaxMemory, getModelClassName, getModelConfigJson, getModelNumLayers, getModelNumParams, getModelParamNames, getSwArch, getSwEnvironmentInfo, getSwHostName, getSwJvmName, getSwJvmSpecVersion, getSwJvmUID, getSwJvmVersion, getSwNd4jBackendClass, getSwNd4jDataTypeName, getSwOsName

Constructor Detail

SbeStatsInitializationReport

public SbeStatsInitializationReport()

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 StatsInitializationReport

reportSoftwareInfo

public void reportSoftwareInfo(java.lang.String arch,
                               java.lang.String osName,
                               java.lang.String jvmName,
                               java.lang.String jvmVersion,
                               java.lang.String jvmSpecVersion,
                               java.lang.String nd4jBackendClass,
                               java.lang.String nd4jDataTypeName,
                               java.lang.String hostname,
                               java.lang.String jvmUid,
                               java.util.Map<java.lang.String,java.lang.String> swEnvironmentInfo)

Specified by:

reportSoftwareInfo in interface StatsInitializationReport

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

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

Specified by:

reportHardwareInfo in interface StatsInitializationReport

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

public void reportModelInfo(java.lang.String modelClassName,
                            java.lang.String modelConfigJson,
                            java.lang.String[] modelParamNames,
                            int numLayers,
                            long numParams)

Description copied from interface: StatsInitializationReport

Report the model information

Specified by:

reportModelInfo in interface StatsInitializationReport

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

public boolean hasSoftwareInfo()

Specified by:

hasSoftwareInfo in interface StatsInitializationReport

hasHardwareInfo

public boolean hasHardwareInfo()

Specified by:

hasHardwareInfo in interface StatsInitializationReport

hasModelInfo

public boolean hasModelInfo()

Specified by:

hasModelInfo in interface StatsInitializationReport

getSessionID

public java.lang.String getSessionID()

Description copied from interface: Persistable

Get the session id

Specified by:

getSessionID in interface Persistable

Returns:

getTypeID

public java.lang.String getTypeID()

Description copied from interface: Persistable

Get the type id

Specified by:

getTypeID in interface Persistable

Returns:

getWorkerID

public java.lang.String getWorkerID()

Description copied from interface: Persistable

Get the worker id

Specified by:

getWorkerID in interface Persistable

Returns:

getTimeStamp

public long getTimeStamp()

Description copied from interface: Persistable

Get when this was created.

Specified by:

getTimeStamp in interface Persistable

Returns:

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(org.agrona.MutableDirectBuffer buffer)

Specified by:

encode in interface AgronaPersistable

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(org.agrona.DirectBuffer buffer)

Specified by:

decode in interface AgronaPersistable

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