Skip to content

List of available Events for Eventbus

FollowSteph edited this page Jan 22, 2021 · 1 revision
Name Description
ExperimentArchivedBusEvent Event used to indicate when an experiment has been archived or unarchived. The reason we include the full experiment is because for example if an experiment is unarchived and hence added to the navbar then we need the experiment instance to not only get the experiment's name and so on but also calculate the status, etc.
ExperimentCreatedBusEvent Event used to indicate when a new experiment has been created. We have to include the full experiment instance because this is used to add the new experiment to the navbar and so on.
ExperimentFavoriteBusEvent Event used to indicate whether or not an experiment has been starred or not. We don't send the whole experiment because we only need to know the state.
ExperimentStartTrainingBusEvent Event used to indicate that an experiment has started training. We pass the full experiment instance because we need the status for the navbar and so on.
ExperimentStopTrainingBusEvent Event used to indicate that an experiment has stopped training. We pass the full experiment instance because components like the navbar need to be able to update the status.
PolicyUpdateBusEvent Event used to indicate policies have been updated for an experiment. The experiment details are taken from the first policy in the list of policies. The policies cannot be null or empty, and each policy has to have the appropriate data such as a run, experiment, model, and project. There is also an added safety check to confirm that all policies belong to the same experiment otherwise there will be an IllegalStateException.
RunUpdateBusEvent Event used to indicate a Run or list of Runs have been updated. Each run must have an experiment, model, and project otherwise the event will fail with an IllegalStateException. The experiment is determined by looking at the experimentId of the first run. Also all runs must have the same experiment otherwise there will be an IllegalStateException.
UserUpdateBusEvent Event used to indicate that there has been a change to the user. This is mainly used to update the user's name on the top right of the screen should it be changed.

Clone this wiki locally