NeuralNet::Callback Class Reference

Inheritance diagram for NeuralNet::Callback:

Public Member Functions
virtual void	onTrainBegin (Model &model)=0
virtual void	onTrainEnd (Model &model)=0
virtual void	onEpochBegin (Model &model)=0
virtual void	onEpochEnd (Model &model)=0
virtual void	onBatchBegin (Model &model)=0
virtual void	onBatchEnd (Model &model)=0

Static Public Member Functions
template<typename T >
static void	callMethod (std::shared_ptr< T > callback, const std::string &methodName, Model &model)
	Calls the method of the callback with the given logs.

Static Protected Member Functions
static void	checkMetric (const std::string &metric, const std::vector< std::string > &metrics)
static std::unordered_map< std::string, Logs >	getLogs (Model &model)

Member Function Documentation

callMethod()

template<typename T >

static void NeuralNet::Callback::callMethod ( std::shared_ptr< T > callback, const std::string & methodName, Model & model )

inlinestatic

Calls the method of the callback with the given logs.

Template Parameters

T	The type of the callback

Parameters

callback	A shared_ptr to the callback
methodName	The name of the method to call (onTrainBegin, onTrainEnd, onEpochBegin, onEpochEnd, onBatchBegin, onBatchEnd)
logs	The logs to pass to the method

Warning

There should be consistency between the names of the logs and the metrics of the callbacks

onEpochEnd()

virtual void NeuralNet::Callback::onEpochEnd ( Model & model )

pure virtual

Implemented in NeuralNet::CSVLogger, NeuralNet::EarlyStopping, and NeuralNet::ModelCheckpoint.

onTrainBegin()

virtual void NeuralNet::Callback::onTrainBegin ( Model & model )

pure virtual

Implemented in NeuralNet::CSVLogger.

onTrainEnd()

virtual void NeuralNet::Callback::onTrainEnd ( Model & model )

pure virtual

Implemented in NeuralNet::CSVLogger.

---

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

• /github/workspace/src/NeuralNet/callbacks/Callback.hpp