org.deeplearning4j.ui.api

Interface UIServer

All Known Implementing Classes:

VertxUIServer

public interface UIServer

Interface for user interface server

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
void	attach(StatsStorage statsStorage) Attach the given StatsStorage instance to the UI, so the data can be visualized
void	detach(StatsStorage statsStorage) Detach the specified StatsStorage instance from the UI
void	disableRemoteListener() Disable the remote listener functionality (disabled by default)
void	enableRemoteListener() Enable the remote listener functionality, storing all data in memory, and attaching the instance to the UI.
void	enableRemoteListener(StatsStorageRouter statsStorage, boolean attach) Enable the remote listener functionality, storing the received results in the specified StatsStorageRouter.
String	getAddress() Get the address of the UI
static UIServer	getInstance() Get (and, initialize if necessary) the UI server.
static UIServer	getInstance(boolean multiSession, org.nd4j.linalg.function.Function<String,StatsStorage> statsStorageProvider) Get (and, initialize if necessary) the UI server.
int	getPort() Get the current port for the UI
List<StatsStorage>	getStatsStorageInstances()
boolean	isAttached(StatsStorage statsStorage) Check whether the specified StatsStorage instance is attached to the UI instance
boolean	isMultiSession() Check if the instance initialized with one of the factory methods (getInstance() or getInstance(boolean, Function)) is in multi-session mode
boolean	isRemoteListenerEnabled()
boolean	isStopped()
void	stop() Stop/shut down the UI server.
static void	stopInstance() Stop UIServer instance, if already running

Method Detail

getInstance

static UIServer getInstance()
                     throws RuntimeException

Get (and, initialize if necessary) the UI server. Singleton pattern - all calls to getInstance() will return the same UI instance.

Returns:

UI instance for this JVM

Throws:

RuntimeException - if the instance has already started in a different mode (multi/single-session)

getInstance

static UIServer getInstance(boolean multiSession,
                            org.nd4j.linalg.function.Function<String,StatsStorage> statsStorageProvider)
                     throws RuntimeException

Get (and, initialize if necessary) the UI server. Singleton pattern - all calls to getInstance() will return the same UI instance.

Parameters:

multiSession - in multi-session mode, multiple training sessions can be visualized in separate browser tabs.
URL path will include session ID as a parameter, i.e.: /train becomes /train/:sessionId

statsStorageProvider - function that returns a StatsStorage containing the given session ID.
Use this to auto-attach StatsStorage if an unknown session ID is passed as URL path parameter in multi-session mode, or leave it null.

Returns:

UI instance for this JVM

Throws:

RuntimeException - if the instance has already started in a different mode (multi/single-session)

stopInstance

static void stopInstance()

Stop UIServer instance, if already running

isStopped

boolean isStopped()

isMultiSession

boolean isMultiSession()

Check if the instance initialized with one of the factory methods (getInstance() or getInstance(boolean, Function)) is in multi-session mode

Returns:

true if the instance is in multi-session

getAddress

String getAddress()

Get the address of the UI

Returns:

Address of the UI

getPort

int getPort()

Get the current port for the UI

attach

void attach(StatsStorage statsStorage)

Attach the given StatsStorage instance to the UI, so the data can be visualized

Parameters:

statsStorage - StatsStorage instance to attach to the UI

detach

void detach(StatsStorage statsStorage)

Detach the specified StatsStorage instance from the UI

Parameters:

statsStorage - StatsStorage instance to detach. If not attached: no op.

isAttached

boolean isAttached(StatsStorage statsStorage)

Check whether the specified StatsStorage instance is attached to the UI instance

Parameters:

statsStorage - StatsStorage instance to attach

Returns:

True if attached

getStatsStorageInstances

List<StatsStorage> getStatsStorageInstances()

Returns:

A list of all StatsStorage instances currently attached

enableRemoteListener

void enableRemoteListener()

Enable the remote listener functionality, storing all data in memory, and attaching the instance to the UI. Typically used with RemoteUIStatsStorageRouter, which will send information remotely to this UI instance

See Also:

enableRemoteListener(StatsStorageRouter, boolean)

enableRemoteListener

void enableRemoteListener(StatsStorageRouter statsStorage,
                          boolean attach)

Enable the remote listener functionality, storing the received results in the specified StatsStorageRouter. If the StatsStorageRouter is a StatsStorage instance, it may (optionally) be attached to the UI, as if attach(StatsStorage) was called on it.

Parameters:

statsStorage - StatsStorageRouter to post the received results to

attach - Whether to attach the given StatsStorage instance to the UI server

disableRemoteListener

void disableRemoteListener()

Disable the remote listener functionality (disabled by default)

isRemoteListenerEnabled

boolean isRemoteListenerEnabled()

Returns:

Whether the remote listener functionality is currently enabled

stop

void stop()

Stop/shut down the UI server.