#include <check_metric.hpp>

Inheritance diagram for lbann::callback::check_metric:

Collaboration diagram for lbann::callback::check_metric:

Public Member Functions
	check_metric (std::string metric_name, std::set< execution_mode > modes, EvalType lower_bound, EvalType upper_bound, bool error_on_failure)

check_metric *	copy () const override

std::string	name () const override
	Return this callback's name. More...

void	on_epoch_end (model *m) override
	Called immediate after the end of each epoch. More...

void	on_validation_end (model *m) override
	Called immediately after the end of validation. More...

void	on_test_end (model *m) override
	Called immediately after the end of testing. More...

Serialization
template<class Archive >
void	serialize (Archive &ar)
	Store state to archive for checkpoint and restart. More...

Public Member Functions inherited from lbann::callback_base
	callback_base (int batch_interval=1)
	Initialize a callback with an optional batch interval. More...

	callback_base (const callback_base &)=default

virtual	~callback_base ()=default

virtual void	setup (trainer *t)
	Called once to set up the callback on the trainer. More...

virtual void	setup (model *m)
	Called once to set up the callback on the model (after all layers are set up). More...

virtual void	on_setup_end (model *m)
	Called at the end of setup. More...

virtual void	on_train_begin (model *m)
	Called at the beginning of training. More...

virtual void	on_train_end (model *m)
	Called at the end of training. More...

virtual void	on_phase_end (model *m)
	Called at the end of every phase (multiple epochs) in a layer-wise model training. More...

virtual void	on_epoch_begin (model *m)
	Called at the beginning of each epoch. More...

virtual void	on_batch_begin (model *m)
	Called at the beginning of a (mini-)batch. More...

virtual void	on_batch_end (model *m)
	Called immediately after the end of a (mini-)batch. More...

virtual void	on_test_begin (model *m)
	Called at the beginning of testing. More...

virtual void	on_validation_begin (model *m)
	Called at the beginning of validation. More...

virtual void	on_forward_prop_begin (model *m)
	Called when a model begins forward propagation. More...

virtual void	on_forward_prop_begin (model m, Layer l)
	Called when a layer begins forward propagation. More...

virtual void	on_forward_prop_end (model *m)
	Called when a model ends forward propagation. More...

virtual void	on_forward_prop_end (model m, Layer l)
	Called when a layer ends forward propagation. More...

virtual void	on_backward_prop_begin (model *m)
	Called when a model begins backward propagation. More...

virtual void	on_backward_prop_begin (model m, Layer l)
	Called when a layer begins backward propagation. More...

virtual void	on_backward_prop_end (model *m)
	Called when a model ends backward propagation. More...

virtual void	on_backward_prop_end (model m, Layer l)
	Called when a layer ends backward propagation. More...

virtual void	on_optimize_begin (model *m)
	Called when a model begins optimization. More...

virtual void	on_optimize_begin (model m, weights w)
	Called when weights begins optimization. More...

virtual void	on_optimize_end (model *m)
	Called when a model ends optimization. More...

virtual void	on_optimize_end (model m, weights w)
	Called when weights ends optimization. More...

virtual void	on_batch_evaluate_begin (model *m)
	Called at the beginning of a (mini-)batch evaluation (validation / testing). More...

virtual void	on_batch_evaluate_end (model *m)
	Called at the end of a (mini-)batch evaluation (validation / testing). More...

virtual void	on_evaluate_forward_prop_begin (model *m)
	Called when a model begins forward propagation for evaluation (validation / testing). More...

virtual void	on_evaluate_forward_prop_begin (model m, Layer l)
	Called when a layer begins forward propagation for evaluation (validation / testing). More...

virtual void	on_evaluate_forward_prop_end (model *m)
	Called when a model ends forward propagation for evaluation (validation / testing). More...

virtual void	on_evaluate_forward_prop_end (model m, Layer l)
	Called when a layer ends forward propagation for evaluation (validation / testing). More...

int	get_batch_interval () const
	Return the batch interval. More...

virtual description	get_description () const
	Human-readable description. More...

template<class Archive >
void	serialize (Archive &ar)
	Store state to archive for checkpoint and restart. More...

void	write_proto (lbann_data::Callback &proto) const
	Write a protobuf description of the callback. More...

Private Member Functions
void	write_specific_proto (lbann_data::Callback &proto) const final

	check_metric ()

void	do_check_metric (const model &m) const

Private Attributes
std::string	m_metric_name

std::set< execution_mode >	m_modes

EvalType	m_lower_bound

EvalType	m_upper_bound

bool	m_error_on_failure

Friends
class	cereal::access

Additional Inherited Members
Protected Member Functions inherited from lbann::callback_base
std::string	get_multi_trainer_path (const model &m, const std::string &root_dir)
	Build a standard directory hierarchy including trainer ID. More...

std::string	get_multi_trainer_ec_model_path (const model &m, const std::string &root_dir)
	Build a standard directory hierachy including trainer, execution context, and model information (in that order). More...

std::string	get_multi_trainer_model_path (const model &m, const std::string &root_dir)
	Build a standard directory hierachy including trainer, model information in that order. More...

callback_base &	operator= (const callback_base &)=default
	Copy-assignment operator. More...

Protected Attributes inherited from lbann::callback_base
int	m_batch_interval
	Batch methods should once every this many steps. More...

Detailed Description

Metric checking callback. Checks if a metric value falls within an expected range.

Definition at line 39 of file check_metric.hpp.

Constructor & Destructor Documentation

◆ check_metric() [1/2]

lbann::callback::check_metric::check_metric	(	std::string	metric_name,
		std::set< execution_mode >	modes,
		EvalType	lower_bound,
		EvalType	upper_bound,
		bool	error_on_failure
	)

◆ check_metric() [2/2]

lbann::callback::check_metric::check_metric ( )

private

Here is the caller graph for this function:

Member Function Documentation

◆ copy()

check_metric* lbann::callback::check_metric::copy ( ) const

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 47 of file check_metric.hpp.

Here is the call graph for this function:

◆ do_check_metric()

void lbann::callback::check_metric::do_check_metric ( const model & m ) const

private

Perform metric check. Does nothing if current execution mode is not in m_modes;

Here is the caller graph for this function:

◆ name()

std::string lbann::callback::check_metric::name ( ) const

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 48 of file check_metric.hpp.

◆ on_epoch_end()

void lbann::callback::check_metric::on_epoch_end ( model * m )

inlineoverridevirtual

Called immediate after the end of each epoch.

Reimplemented from lbann::callback_base.

Definition at line 50 of file check_metric.hpp.

Here is the call graph for this function:

◆ on_test_end()

void lbann::callback::check_metric::on_test_end ( model * m )

inlineoverridevirtual

Called immediately after the end of testing.

Reimplemented from lbann::callback_base.

Definition at line 52 of file check_metric.hpp.

Here is the call graph for this function:

◆ on_validation_end()

void lbann::callback::check_metric::on_validation_end ( model * m )

inlineoverridevirtual

Called immediately after the end of validation.

Reimplemented from lbann::callback_base.

Definition at line 51 of file check_metric.hpp.

Here is the call graph for this function:

◆ serialize()

template<class Archive >

void lbann::callback::check_metric::serialize ( Archive & ar )

Store state to archive for checkpoint and restart.

Here is the caller graph for this function:

◆ write_specific_proto()

void lbann::callback::check_metric::write_specific_proto ( lbann_data::Callback & proto ) const

finalprivatevirtual

Add callback specific data to prototext

Implements lbann::callback_base.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 67 of file check_metric.hpp.

Member Data Documentation

◆ m_error_on_failure

bool lbann::callback::check_metric::m_error_on_failure

private

Whether to throw an exception if metric check fails.

Definition at line 82 of file check_metric.hpp.

◆ m_lower_bound

EvalType lbann::callback::check_metric::m_lower_bound

private

Lower bound for metric value.

Definition at line 77 of file check_metric.hpp.

◆ m_metric_name

std::string lbann::callback::check_metric::m_metric_name

private

Metric name.

Definition at line 71 of file check_metric.hpp.

◆ m_modes

std::set<execution_mode> lbann::callback::check_metric::m_modes

private

Execution modes with metric checks.

Definition at line 74 of file check_metric.hpp.

◆ m_upper_bound

EvalType lbann::callback::check_metric::m_upper_bound

private

Upper bound for metric value.

Definition at line 79 of file check_metric.hpp.

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

check_metric.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ check_metric() [1/2]

◆ check_metric() [2/2]

Member Function Documentation

◆ copy()

◆ do_check_metric()

◆ name()

◆ on_epoch_end()

◆ on_test_end()

◆ on_validation_end()

◆ serialize()

◆ write_specific_proto()

Friends And Related Function Documentation

◆ cereal::access

Member Data Documentation

◆ m_error_on_failure

◆ m_lower_bound

◆ m_metric_name

◆ m_modes

◆ m_upper_bound