org.deeplearning4j.ui.api

Class UIServer

java.lang.Object

org.deeplearning4j.ui.api.UIServer

Direct Known Subclasses:

PlayUIServer

public abstract class UIServer
extends java.lang.Object

Interface for user interface server

Constructor Summary

Constructors

Constructor and Description
UIServer()

Method Summary

Modifier and Type	Method and Description
abstract void	attach(StatsStorage statsStorage) Attach the given StatsStorage instance to the UI, so the data can be visualized
abstract void	detach(StatsStorage statsStorage) Detach the specified StatsStorage instance from the UI
abstract void	disableRemoteListener() Disable the remote listener functionality (disabled by default)
abstract void	enableRemoteListener() Enable the remote listener functionality, storing all data in memory, and attaching the instance to the UI.
abstract void	enableRemoteListener(StatsStorageRouter statsStorage, boolean attach) Enable the remote listener functionality, storing the received results in the specified StatsStorageRouter.
static UIServer	getInstance() Get (and, initialize if necessary) the UI server.
abstract int	getPort() Get the current port for the UI
abstract java.util.List<StatsStorage>	getStatsStorageInstances()
abstract boolean	isAttached(StatsStorage statsStorage) Check whether the specified StatsStorage instance is attached to the UI instance
abstract boolean	isRemoteListenerEnabled()
abstract void	stop() Stop/shut down the UI server.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIServer

public UIServer()

Method Detail

getInstance

public static UIServer getInstance()

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

getPort

public abstract int getPort()

Get the current port for the UI

attach

public abstract 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

public abstract void detach(StatsStorage statsStorage)

Detach the specified StatsStorage instance from the UI

Parameters:

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

isAttached

public abstract 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

public abstract java.util.List<StatsStorage> getStatsStorageInstances()

Returns:

A list of all StatsStorage instances currently attached

enableRemoteListener

public abstract 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

public abstract 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

public abstract void disableRemoteListener()

Disable the remote listener functionality (disabled by default)

isRemoteListenerEnabled

public abstract boolean isRemoteListenerEnabled()

Returns:

Whether the remote listener functionality is currently enabled

stop

public abstract void stop()

Stop/shut down the UI server.