org.deeplearning4j.ui.api

Interface UIModule

All Known Implementing Classes:

ArbiterModule, ConvolutionalListenerModule, DefaultModule, RemoteReceiverModule, SameDiffModule, TrainModule, TsneModule

public interface UIModule

UIModule encapsulates the user interface functionality for a page or group of pages that rely on data coming from a StatsStorage instance.
When a StatsStorage object is attached to a UIServer, the UI server will start receiving StatsStorageEvent instances; some of these (only the appropriate ones based on the specified TypeIDs from the getCallbackTypeIDs() method) will be routed to the UIModule, via reportStorageEvents(Collection). Each UIModule will generally handle one (or at most a few) different types of data (Type IDs); note however that events for a single Type ID can be routed to multiple UI modules, if required.

The UIModule also encapsulates the relevant routing information: i.e., what GET/PUT (etc) methods are available for this module, and how those methods should be handled.

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
List<String>	getCallbackTypeIDs() Get the list of Type IDs that should be collected from the registered StatsStorage instances, and passed on to the reportStorageEvents(Collection) method.
List<I18NResource>	getInternationalizationResources()
List<Route>	getRoutes() Get a list of Route objects, that specify GET/SET etc methods, and how these should be handled.
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(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 getCallbackTypeIDs().

Method Detail

getCallbackTypeIDs

List<String> getCallbackTypeIDs()

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

Returns:

List of relevant Type IDs

getRoutes

List<Route> getRoutes()

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

Returns:

List of routes

reportStorageEvents

void reportStorageEvents(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 getCallbackTypeIDs().
Typically, these will be batched together at least somewhat, rather than being reported individually.

Parameters:

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

onAttach

void onAttach(StatsStorage statsStorage)

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

Parameters:

statsStorage - Stats storage that has been attached

onDetach

void onDetach(StatsStorage statsStorage)

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

Parameters:

statsStorage - Stats storage that has been detached

getInternationalizationResources

List<I18NResource> getInternationalizationResources()

Returns:

List of internationalization resources