org.deeplearning4j.api.storage.impl

Class RemoteUIStatsStorageRouter

java.lang.Object

org.deeplearning4j.api.storage.impl.RemoteUIStatsStorageRouter

All Implemented Interfaces:

StatsStorageRouter

public class RemoteUIStatsStorageRouter
extends java.lang.Object
implements StatsStorageRouter

Asynchronously post all updates to a remote UI that has remote listening enabled.
Typically used with UIServer (don't forget to enable remote listener support - UIServer.getInstance().enableRemoteListener()

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_BASE_RETR_DELAY_MS Base delay for retries
static int	DEFAULT_MAX_RETRIES Default maximum number of (consecutive) retries on failure
static java.lang.String	DEFAULT_PATH Default path for posting data to the UI - i.e., http://localhost:9000/remoteReceive or similar
static double	DEFAULT_RETRY_BACKOFF_FACTOR Default backoff multiplicative factor for retrying

Constructor Summary

Constructors

Constructor and Description
RemoteUIStatsStorageRouter(java.lang.String address) Create remote UI with defaults for all values except address
RemoteUIStatsStorageRouter(java.lang.String address, int maxRetryCount, long retryDelayMS, double retryBackoffFactor)
RemoteUIStatsStorageRouter(java.lang.String address, java.lang.String path, int maxRetryCount, long retryDelayMS, double retryBackoffFactor)

Method Summary

Modifier and Type	Method and Description
void	putStaticInfo(java.util.Collection<? extends Persistable> staticInfo) Static info: reported once per session, upon initialization
void	putStaticInfo(Persistable staticInfo) Static info: reported once per session, upon initialization
void	putStorageMetaData(java.util.Collection<? extends StorageMetaData> storageMetaData)
void	putStorageMetaData(StorageMetaData storageMetaData) Method to store some additional metadata for each session.
void	putUpdate(java.util.Collection<? extends Persistable> updates) Updates: stored multiple times per session (periodically, for example)
void	putUpdate(Persistable update) Updates: stored multiple times per session (periodically, for example)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATH

public static final java.lang.String DEFAULT_PATH

Default path for posting data to the UI - i.e., http://localhost:9000/remoteReceive or similar

See Also:

Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

Default maximum number of (consecutive) retries on failure

See Also:

Constant Field Values

DEFAULT_BASE_RETR_DELAY_MS

public static final long DEFAULT_BASE_RETR_DELAY_MS

Base delay for retries

See Also:

Constant Field Values

DEFAULT_RETRY_BACKOFF_FACTOR

public static final double DEFAULT_RETRY_BACKOFF_FACTOR

Default backoff multiplicative factor for retrying

See Also:

Constant Field Values

Constructor Detail

RemoteUIStatsStorageRouter

public RemoteUIStatsStorageRouter(java.lang.String address)

Create remote UI with defaults for all values except address

Parameters:

address - Address of the remote UI: for example, "http://localhost:9000"

RemoteUIStatsStorageRouter

public RemoteUIStatsStorageRouter(java.lang.String address,
                                  int maxRetryCount,
                                  long retryDelayMS,
                                  double retryBackoffFactor)

Parameters:

address - Address of the remote UI: for example, "http://localhost:9000"

maxRetryCount - Maximum number of retries before failing. Set to -1 to always retry

retryDelayMS - Base delay before retrying, in milliseconds

retryBackoffFactor - Backoff factor for retrying: 2.0 for example gives delays of 1000, 2000, 4000, 8000, etc milliseconds, with a base retry delay of 1000

RemoteUIStatsStorageRouter

public RemoteUIStatsStorageRouter(java.lang.String address,
                                  java.lang.String path,
                                  int maxRetryCount,
                                  long retryDelayMS,
                                  double retryBackoffFactor)

Parameters:

address - Address of the remote UI: for example, "http://localhost:9000"

path - Path/endpoint to post to: for example "remoteReceive" -> added to path to become like "http://localhost:9000/remoteReceive"

maxRetryCount - Maximum number of retries before failing. Set to -1 to always retry

retryDelayMS - Base delay before retrying, in milliseconds

retryBackoffFactor - Backoff factor for retrying: 2.0 for example gives delays of 1000, 2000, 4000, 8000, etc milliseconds, with a base retry delay of 1000

Method Detail

putStorageMetaData

public void putStorageMetaData(StorageMetaData storageMetaData)

Description copied from interface: StatsStorageRouter

Method to store some additional metadata for each session. Idea: record the classes used to serialize and deserialize the static info and updates (as a class name). This is mainly used for debugging and validation.

Specified by:

putStorageMetaData in interface StatsStorageRouter

Parameters:

storageMetaData - Storage metadata to store

putStorageMetaData

public void putStorageMetaData(java.util.Collection<? extends StorageMetaData> storageMetaData)

Specified by:

putStorageMetaData in interface StatsStorageRouter

putStaticInfo

public void putStaticInfo(Persistable staticInfo)

Description copied from interface: StatsStorageRouter

Static info: reported once per session, upon initialization

Specified by:

putStaticInfo in interface StatsStorageRouter

Parameters:

staticInfo - Static info to store

putStaticInfo

public void putStaticInfo(java.util.Collection<? extends Persistable> staticInfo)

Description copied from interface: StatsStorageRouter

Static info: reported once per session, upon initialization

Specified by:

putStaticInfo in interface StatsStorageRouter

Parameters:

staticInfo - Static info to store

putUpdate

public void putUpdate(Persistable update)

Description copied from interface: StatsStorageRouter

Updates: stored multiple times per session (periodically, for example)

Specified by:

putUpdate in interface StatsStorageRouter

Parameters:

update - Update info to store

putUpdate

public void putUpdate(java.util.Collection<? extends Persistable> updates)

Description copied from interface: StatsStorageRouter

Updates: stored multiple times per session (periodically, for example)

Specified by:

putUpdate in interface StatsStorageRouter

Parameters:

updates - Update info to store