Mila::Dnn::ModelCallback< TInput, TPrecision > Class Template Reference

Interface for callbacks during training. More...

Public Member Functions
virtual	~ModelCallback ()=default
virtual void	onBatchBegin (size_t batch)
	Called at the beginning of each batch.
virtual void	onBatchEnd (size_t batch, const std::unordered_map< std::string, float > &metrics)
	Called at the end of each batch.
virtual void	onEpochBegin (size_t epoch)
	Called at the beginning of each epoch.
virtual void	onEpochEnd (size_t epoch, const std::unordered_map< std::string, float > &metrics)
	Called at the end of each epoch.
virtual void	onTrainingBegin ()
	Called at the beginning of training.
virtual void	onTrainingEnd ()
	Called at the end of training.

Detailed Description

template<typename TInput, typename TPrecision>
class Mila::Dnn::ModelCallback< TInput, TPrecision >

Interface for callbacks during training.

Constructor & Destructor Documentation

~ModelCallback()

template<typename TInput , typename TPrecision >

virtual Mila::Dnn::ModelCallback< TInput, TPrecision >::~ModelCallback ( )

virtualdefault

Member Function Documentation

onBatchBegin()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onBatchBegin ( size_t  batch )

inlinevirtual

Called at the beginning of each batch.

Parameters

batch

The current batch number.

onBatchEnd()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onBatchEnd ( size_t  batch, const std::unordered_map< std::string, float > &  metrics  )

inlinevirtual

Called at the end of each batch.

Parameters

batch	The current batch number.
metrics	The metrics from the batch.

onEpochBegin()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onEpochBegin ( size_t  epoch )

inlinevirtual

Called at the beginning of each epoch.

Parameters

epoch

The current epoch number.

onEpochEnd()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onEpochEnd ( size_t  epoch, const std::unordered_map< std::string, float > &  metrics  )

inlinevirtual

Called at the end of each epoch.

Parameters

epoch	The current epoch number.
metrics	The metrics from the epoch.

onTrainingBegin()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onTrainingBegin ( )

inlinevirtual

Called at the beginning of training.

onTrainingEnd()

template<typename TInput , typename TPrecision >

virtual void Mila::Dnn::ModelCallback< TInput, TPrecision >::onTrainingEnd ( )

inlinevirtual

Called at the end of training.

---

The documentation for this class was generated from the following file:

• /home/runner/work/Mila/Mila/Mila/Src/Dnn/Models/ModelCallback.ixx