org.deeplearning4j.ui.play

Class PlayUIServer

java.lang.Object

org.deeplearning4j.ui.api.UIServer

org.deeplearning4j.ui.play.PlayUIServer

public class PlayUIServer
extends UIServer

A UI server based on the Play framework

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSETS_ROOT_DIRECTORY
static int	DEFAULT_UI_PORT
static String	UI_CUSTOM_MODULE_PROPERTY System property to enable classpath scanning for custom UI modules.
static String	UI_SERVER_PORT_PROPERTY System property for setting the UI port.

Constructor Summary

Constructors

Constructor and Description
PlayUIServer()
PlayUIServer(int port)

Method Summary

Modifier and Type	Method and Description
void	attach(org.deeplearning4j.api.storage.StatsStorage statsStorage) Attach the given StatsStorage instance to the UI, so the data can be visualized
void	detach(org.deeplearning4j.api.storage.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(org.deeplearning4j.api.storage.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
int	getPort() Get the current port for the UI
List<org.deeplearning4j.api.storage.StatsStorage>	getStatsStorageInstances()
boolean	isAttached(org.deeplearning4j.api.storage.StatsStorage statsStorage) Check whether the specified StatsStorage instance is attached to the UI instance
boolean	isRemoteListenerEnabled()
static void	main(String[] args)
void	runMain(String[] args)
void	stop() Stop/shut down the UI server.

Methods inherited from class org.deeplearning4j.ui.api.UIServer

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

UI_SERVER_PORT_PROPERTY

public static final String UI_SERVER_PORT_PROPERTY

System property for setting the UI port. Defaults to 9000. Set to 0 to use a random port

See Also:

Constant Field Values

DEFAULT_UI_PORT

public static final int DEFAULT_UI_PORT

See Also:

Constant Field Values

UI_CUSTOM_MODULE_PROPERTY

public static final String UI_CUSTOM_MODULE_PROPERTY

System property to enable classpath scanning for custom UI modules. Disabled by default.

See Also:

Constant Field Values

ASSETS_ROOT_DIRECTORY

public static final String ASSETS_ROOT_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

PlayUIServer

public PlayUIServer()

PlayUIServer

public PlayUIServer(int port)

Method Detail

runMain

public void runMain(String[] args)

getAddress

public String getAddress()

Description copied from class: UIServer

Get the address of the UI

Specified by:

getAddress in class UIServer

Returns:

Address of the UI

main

public static void main(String[] args)

getPort

public int getPort()

Description copied from class: UIServer

Get the current port for the UI

Specified by:

getPort in class UIServer

attach

public void attach(org.deeplearning4j.api.storage.StatsStorage statsStorage)

Description copied from class: UIServer

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

Specified by:

attach in class UIServer

Parameters:

statsStorage - StatsStorage instance to attach to the UI

detach

public void detach(org.deeplearning4j.api.storage.StatsStorage statsStorage)

Description copied from class: UIServer

Detach the specified StatsStorage instance from the UI

Specified by:

detach in class UIServer

Parameters:

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

isAttached

public boolean isAttached(org.deeplearning4j.api.storage.StatsStorage statsStorage)

Description copied from class: UIServer

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

Specified by:

isAttached in class UIServer

Parameters:

statsStorage - StatsStorage instance to attach

Returns:

True if attached

getStatsStorageInstances

public List<org.deeplearning4j.api.storage.StatsStorage> getStatsStorageInstances()

Specified by:

getStatsStorageInstances in class UIServer

Returns:

A list of all StatsStorage instances currently attached

enableRemoteListener

public void enableRemoteListener()

Description copied from class: UIServer

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

Specified by:

enableRemoteListener in class UIServer

See Also:

UIServer.enableRemoteListener(StatsStorageRouter, boolean)

enableRemoteListener

public void enableRemoteListener(org.deeplearning4j.api.storage.StatsStorageRouter statsStorage,
                                 boolean attach)

Description copied from class: UIServer

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 UIServer.attach(StatsStorage) was called on it.

Specified by:

enableRemoteListener in class UIServer

Parameters:

statsStorage - StatsStorageRouter to post the received results to

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

disableRemoteListener

public void disableRemoteListener()

Description copied from class: UIServer

Disable the remote listener functionality (disabled by default)

Specified by:

disableRemoteListener in class UIServer

isRemoteListenerEnabled

public boolean isRemoteListenerEnabled()

Specified by:

isRemoteListenerEnabled in class UIServer

Returns:

Whether the remote listener functionality is currently enabled

stop

public void stop()

Description copied from class: UIServer

Stop/shut down the UI server.

Specified by:

stop in class UIServer