#include <print_statistics.hpp>

Inheritance diagram for lbann::callback::print_statistics:

Collaboration diagram for lbann::callback::print_statistics:

Public Member Functions
	print_statistics (int batch_interval=1, bool print_global_stat_only=false)

	print_statistics (const print_statistics &)=default

print_statistics &	operator= (const print_statistics &)=default

print_statistics *	copy () const override

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

void	on_epoch_begin (model *m) override
	Called at the beginning of each epoch. 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...

std::string	name () const override
	Return this callback's name. 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	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_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

void	report_results (model *m)

Private Attributes
bool	m_print_global_stat_only

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

Periodically print computational results. Prints average objective function value and metric scores after each training epoch and evaluation.

Definition at line 41 of file print_statistics.hpp.

Constructor & Destructor Documentation

◆ print_statistics() [1/2]

lbann::callback::print_statistics::print_statistics	(	int	batch_interval = `1`,
		bool	print_global_stat_only = `false`
	)

inline

Definition at line 44 of file print_statistics.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_statistics() [2/2]

lbann::callback::print_statistics::print_statistics ( const print_statistics & )

default

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 50 of file print_statistics.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 59 of file print_statistics.hpp.

Here is the call graph for this function:

◆ on_epoch_begin()

void lbann::callback::print_statistics::on_epoch_begin ( model * m )

overridevirtual

Called at the beginning of each epoch.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_epoch_end()

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

overridevirtual

Called immediate after the end of each epoch.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_test_end()

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

overridevirtual

Called immediately after the end of testing.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_validation_end()

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

overridevirtual

Called immediately after the end of validation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ operator=()

print_statistics& lbann::callback::print_statistics::operator= ( const print_statistics & )

default

Here is the caller graph for this function:

◆ report_results()

void lbann::callback::print_statistics::report_results ( model * m )

private

Print objective function and metrics to standard output.

Here is the caller graph for this function:

◆ serialize()

template<class Archive >

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

Store state to archive for checkpoint and restart.

Here is the caller graph for this function:

◆ setup()

void lbann::callback::print_statistics::setup ( model * m )

overridevirtual

Called once to set up the callback on the model (after all layers are set up).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ write_specific_proto()

void lbann::callback::print_statistics::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:

Member Data Documentation

◆ m_print_global_stat_only

bool lbann::callback::print_statistics::m_print_global_stat_only

private

Definition at line 76 of file print_statistics.hpp.

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

print_statistics.hpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ print_statistics() [1/2]

◆ print_statistics() [2/2]

Member Function Documentation

◆ copy()

◆ name()

◆ on_epoch_begin()

◆ on_epoch_end()

◆ on_test_end()

◆ on_validation_end()

◆ operator=()

◆ report_results()

◆ serialize()

◆ setup()

◆ write_specific_proto()

Member Data Documentation

◆ m_print_global_stat_only