prints a progress bar during training More...

#include <progress_bar.hpp>

Inheritance diagram for lbann::callback::progress_bar:

Collaboration diagram for lbann::callback::progress_bar:

Public Member Functions
	progress_bar (int batch_interval=1, int newline_interval=0)

	progress_bar (const progress_bar &)=default

progress_bar &	operator= (const progress_bar &)=default

progress_bar *	copy () const override

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

void	on_forward_prop_begin (model *m) override
	Called when a model begins forward propagation. 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	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_end (model *m)
	Called immediate after the end 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_test_end (model *m)
	Called immediately after the end of testing. More...

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

virtual void	on_validation_end (model *m)
	Called immediately after the end of validation. 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

Private Attributes
int	m_newline_interval

bool	m_print

int	m_training_iterations

int	m_current_iteration

std::array< double, LBANN_PBAR_MOVING_AVERAGE_LENGTH >	m_moving_avg_time

double	m_last_time

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

prints a progress bar during training

Definition at line 44 of file progress_bar.hpp.

Constructor & Destructor Documentation

◆ progress_bar() [1/2]

lbann::callback::progress_bar::progress_bar	(	int	batch_interval = `1`,
		int	newline_interval = `0`
	)

inline

Parameters

batch_interval The frequency at which to print the progress bar.

Definition at line 53 of file progress_bar.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ progress_bar() [2/2]

lbann::callback::progress_bar::progress_bar ( const progress_bar & )

default

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 58 of file progress_bar.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 63 of file progress_bar.hpp.

Here is the call graph for this function:

◆ on_epoch_begin()

void lbann::callback::progress_bar::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_forward_prop_begin()

void lbann::callback::progress_bar::on_forward_prop_begin ( model * m )

overridevirtual

Called when a model begins forward propagation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ operator=()

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

default

Here is the caller graph for this function:

◆ serialize()

template<class Archive >

void lbann::callback::progress_bar::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::progress_bar::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 78 of file progress_bar.hpp.

Member Data Documentation

◆ m_current_iteration

int lbann::callback::progress_bar::m_current_iteration

private

Definition at line 86 of file progress_bar.hpp.

◆ m_last_time

double lbann::callback::progress_bar::m_last_time

private

Time measurement (last time forward prop was called).

Definition at line 92 of file progress_bar.hpp.

◆ m_moving_avg_time

std::array<double, LBANN_PBAR_MOVING_AVERAGE_LENGTH> lbann::callback::progress_bar::m_moving_avg_time

private

Set up a rolling buffer for a moving average

Definition at line 89 of file progress_bar.hpp.

◆ m_newline_interval

int lbann::callback::progress_bar::m_newline_interval

private

Definition at line 81 of file progress_bar.hpp.

◆ m_print

bool lbann::callback::progress_bar::m_print

private

Definition at line 84 of file progress_bar.hpp.

◆ m_training_iterations

int lbann::callback::progress_bar::m_training_iterations

private

Definition at line 85 of file progress_bar.hpp.

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

progress_bar.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ progress_bar() [1/2]

◆ progress_bar() [2/2]

Member Function Documentation

◆ copy()

◆ name()

◆ on_epoch_begin()

◆ on_forward_prop_begin()

◆ operator=()

◆ serialize()

◆ write_specific_proto()

Friends And Related Function Documentation

◆ cereal::access

Member Data Documentation

◆ m_current_iteration

◆ m_last_time

◆ m_moving_avg_time

◆ m_newline_interval

◆ m_print

◆ m_training_iterations