org.deeplearning4j.ui.module.remote

Class RemoteReceiverModule

java.lang.Object

org.deeplearning4j.ui.module.remote.RemoteReceiverModule

All Implemented Interfaces:

UIModule

public class RemoteReceiverModule
extends java.lang.Object
implements UIModule

Used to receive UI updates remotely. Used in conjunction with RemoteUIStatsStorageRouter, which posts to the UI. UI information is then deserialized and routed to the specified StatsStorageRouter, which may (or may not) be attached to the UI

Constructor Summary

Constructors

Constructor and Description
RemoteReceiverModule()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCallbackTypeIDs() Get the list of Type IDs that should be collected from the registered StatsStorage instances, and passed on to the UIModule.reportStorageEvents(Collection) method.
java.util.List<Route>	getRoutes() Get a list of Route objects, that specify GET/SET etc methods, and how these should be handled.
boolean	isEnabled()
void	onAttach(StatsStorage statsStorage) Notify the UI module that the given StatsStorage instance has been attached to the UI
void	onDetach(StatsStorage statsStorage) Notify the UI module that the given StatsStorage instance has been detached from the UI
void	reportStorageEvents(java.util.Collection<StatsStorageEvent> events) Whenever the UIServer receives some StatsStorageEvents from one of the registered StatsStorage instances, it will filter these and pass on to the UI module those ones that match one of the Type IDs from UIModule.getCallbackTypeIDs(). Typically, these will be batched together at least somewhat, rather than being reported individually.
void	setEnabled(boolean enabled)
void	setStatsStorage(StatsStorageRouter statsStorage)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteReceiverModule

public RemoteReceiverModule()

Method Detail

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

setStatsStorage

public void setStatsStorage(StatsStorageRouter statsStorage)

getCallbackTypeIDs

public java.util.List<java.lang.String> getCallbackTypeIDs()

Description copied from interface: UIModule

Get the list of Type IDs that should be collected from the registered StatsStorage instances, and passed on to the UIModule.reportStorageEvents(Collection) method.

Specified by:

getCallbackTypeIDs in interface UIModule

Returns:

List of relevant Type IDs

getRoutes

public java.util.List<Route> getRoutes()

Description copied from interface: UIModule

Get a list of Route objects, that specify GET/SET etc methods, and how these should be handled.

Specified by:

getRoutes in interface UIModule

Returns:

List of routes

reportStorageEvents

public void reportStorageEvents(java.util.Collection<StatsStorageEvent> events)

Description copied from interface: UIModule

Whenever the UIServer receives some StatsStorageEvents from one of the registered StatsStorage instances, it will filter these and pass on to the UI module those ones that match one of the Type IDs from UIModule.getCallbackTypeIDs().
Typically, these will be batched together at least somewhat, rather than being reported individually.

Specified by:

reportStorageEvents in interface UIModule

Parameters:

events - List of relevant events (type IDs match one of those from UIModule.getCallbackTypeIDs()

onAttach

public void onAttach(StatsStorage statsStorage)

Description copied from interface: UIModule

Notify the UI module that the given StatsStorage instance has been attached to the UI

Specified by:

onAttach in interface UIModule

Parameters:

statsStorage - Stats storage that has been attached

onDetach

public void onDetach(StatsStorage statsStorage)

Description copied from interface: UIModule

Notify the UI module that the given StatsStorage instance has been detached from the UI

Specified by:

onDetach in interface UIModule

Parameters:

statsStorage - Stats storage that has been detached