Package ai.djl.training.listener

Interface TrainingListener

All Known Implementing Classes:

DivergenceCheckTrainingListener, EarlyStoppingListener, EpochTrainingListener, EvaluatorTrainingListener, LoggingTrainingListener, MemoryTrainingListener, SaveModelTrainingListener, TimeMeasureTrainingListener, TrainingListenerAdapter

public interface TrainingListener

TrainingListener offers an interface that performs some actions when certain events have occurred in the Trainer.

The methods onEpoch, onTrainingBatch, onValidationBatch are called during training. Adding an implementation of the listener to the Trainer will perform any desired action at those junctures. These could be used for collection metrics, or logging, or any other purpose to enhance the training process.

There are many listeners that contain different functionality, and it is often best to combine a number of listeners. We recommend starting with one of our sets of TrainingListener.Defaults. Then, more listeners can be added afterwards.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TrainingListener.BatchData	A class to pass data from the batch into the training listeners.
static interface	TrainingListener.Defaults	Contains default TrainingListener sets.

Method Summary

Modifier and Type	Method	Description
void	onEpoch(Trainer trainer)	Listens to the end of an epoch during training.
void	onTrainingBatch(Trainer trainer, TrainingListener.BatchData batchData)	Listens to the end of training one batch of data during training.
void	onTrainingBegin(Trainer trainer)	Listens to the beginning of training.
void	onTrainingEnd(Trainer trainer)	Listens to the end of training.
void	onValidationBatch(Trainer trainer, TrainingListener.BatchData batchData)	Listens to the end of validating one batch of data during validation.

Method Details

onEpoch

void onEpoch(Trainer trainer)

Listens to the end of an epoch during training.

Parameters:

trainer - the trainer the listener is attached to

onTrainingBatch

void onTrainingBatch(Trainer trainer,
 TrainingListener.BatchData batchData)

Listens to the end of training one batch of data during training.

Parameters:

trainer - the trainer the listener is attached to

batchData - the data from the batch

onValidationBatch

void onValidationBatch(Trainer trainer,
 TrainingListener.BatchData batchData)

Listens to the end of validating one batch of data during validation.

Parameters:

trainer - the trainer the listener is attached to

batchData - the data from the batch

onTrainingBegin

void onTrainingBegin(Trainer trainer)

Listens to the beginning of training.

Parameters:

trainer - the trainer the listener is attached to

onTrainingEnd

void onTrainingEnd(Trainer trainer)

Listens to the end of training.

Parameters:

trainer - the trainer the listener is attached to