Package org.deeplearning4j.ui.api

Interface UIModule

All Known Implementing Classes:

ConvolutionalListenerModule, DefaultModule, RemoteReceiverModule, SameDiffModule, TrainModule, TsneModule

public interface UIModule

Method Summary

Modifier and Type	Method	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(). Typically, these will be batched together at least somewhat, rather than being reported individually.

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