#include <profiler.hpp>

Inheritance diagram for lbann::callback::profiler:

Collaboration diagram for lbann::callback::profiler:

Public Member Functions
	profiler (bool sync=false, bool skip_init=false)

	profiler (const profiler &)=default

profiler &	operator= (const profiler &)=default

	~profiler ()

profiler *	copy () const override

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_begin (model *m) override
	Called at the beginning of validation. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	on_optimize_end (model m, weights w) override
	Called when weights ends optimization. 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...

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

int	get_color (Layer *l)

Private Attributes
bool	m_sync

bool	m_skip_init

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

Definition at line 39 of file profiler.hpp.

Constructor & Destructor Documentation

◆ profiler() [1/2]

lbann::callback::profiler::profiler	(	bool	sync = `false`,
		bool	skip_init = `false`
	)

Here is the caller graph for this function:

◆ profiler() [2/2]

lbann::callback::profiler::profiler ( const profiler & )

default

◆ ~profiler()

lbann::callback::profiler::~profiler ( )

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 46 of file profiler.hpp.

Here is the call graph for this function:

◆ get_color()

int lbann::callback::profiler::get_color ( Layer * l )

private

Get a color to use in the profiler for a layer.

Here is the caller graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 73 of file profiler.hpp.

Here is the call graph for this function:

◆ on_backward_prop_begin() [1/2]

void lbann::callback::profiler::on_backward_prop_begin ( model * m )

overridevirtual

Called when a model begins backward propagation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_backward_prop_begin() [2/2]

void lbann::callback::profiler::on_backward_prop_begin	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer begins backward propagation.

Reimplemented from lbann::callback_base.

◆ on_backward_prop_end() [1/2]

void lbann::callback::profiler::on_backward_prop_end ( model * m )

overridevirtual

Called when a model ends backward propagation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_backward_prop_end() [2/2]

void lbann::callback::profiler::on_backward_prop_end	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer ends backward propagation.

Reimplemented from lbann::callback_base.

◆ on_batch_begin()

void lbann::callback::profiler::on_batch_begin ( model * m )

overridevirtual

Called at the beginning of a (mini-)batch.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_batch_end()

void lbann::callback::profiler::on_batch_end ( model * m )

overridevirtual

Called immediately after the end of a (mini-)batch.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_batch_evaluate_begin()

void lbann::callback::profiler::on_batch_evaluate_begin ( model * m )

overridevirtual

Called at the beginning of a (mini-)batch evaluation (validation / testing).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_batch_evaluate_end()

void lbann::callback::profiler::on_batch_evaluate_end ( model * m )

overridevirtual

Called at the end of a (mini-)batch evaluation (validation / testing).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_epoch_begin()

void lbann::callback::profiler::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::profiler::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_evaluate_forward_prop_begin() [1/2]

void lbann::callback::profiler::on_evaluate_forward_prop_begin ( model * m )

overridevirtual

Called when a model begins forward propagation for evaluation (validation / testing).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_evaluate_forward_prop_begin() [2/2]

void lbann::callback::profiler::on_evaluate_forward_prop_begin	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer begins forward propagation for evaluation (validation / testing).

Reimplemented from lbann::callback_base.

◆ on_evaluate_forward_prop_end() [1/2]

void lbann::callback::profiler::on_evaluate_forward_prop_end ( model * m )

overridevirtual

Called when a model ends forward propagation for evaluation (validation / testing).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_evaluate_forward_prop_end() [2/2]

void lbann::callback::profiler::on_evaluate_forward_prop_end	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer ends forward propagation for evaluation (validation / testing).

Reimplemented from lbann::callback_base.

◆ on_forward_prop_begin() [1/2]

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

◆ on_forward_prop_begin() [2/2]

void lbann::callback::profiler::on_forward_prop_begin	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer begins forward propagation.

Reimplemented from lbann::callback_base.

◆ on_forward_prop_end() [1/2]

void lbann::callback::profiler::on_forward_prop_end ( model * m )

overridevirtual

Called when a model ends forward propagation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_forward_prop_end() [2/2]

void lbann::callback::profiler::on_forward_prop_end	(	model *	m,
		Layer *	l
	)

overridevirtual

Called when a layer ends forward propagation.

Reimplemented from lbann::callback_base.

◆ on_optimize_begin() [1/2]

void lbann::callback::profiler::on_optimize_begin ( model * m )

overridevirtual

Called when a model begins optimization.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_optimize_begin() [2/2]

void lbann::callback::profiler::on_optimize_begin	(	model *	m,
		weights *	w
	)

overridevirtual

Called when weights begins optimization.

Reimplemented from lbann::callback_base.

◆ on_optimize_end() [1/2]

void lbann::callback::profiler::on_optimize_end ( model * m )

overridevirtual

Called when a model ends optimization.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_optimize_end() [2/2]

void lbann::callback::profiler::on_optimize_end	(	model *	m,
		weights *	w
	)

overridevirtual

Called when weights ends optimization.

Reimplemented from lbann::callback_base.

◆ on_test_begin()

void lbann::callback::profiler::on_test_begin ( model * m )

overridevirtual

Called at the beginning of testing.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_test_end()

void lbann::callback::profiler::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_begin()

void lbann::callback::profiler::on_validation_begin ( model * m )

overridevirtual

Called at the beginning of validation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_validation_end()

void lbann::callback::profiler::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=()

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

default

◆ serialize()

template<class Archive >

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

bool lbann::callback::profiler::m_skip_init

private

Whether to skip initial iterations.

Definition at line 93 of file profiler.hpp.

◆ m_sync

bool lbann::callback::profiler::m_sync

private

Whether to synchronize the when setting up profile regions.

Definition at line 91 of file profiler.hpp.

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

profiler.hpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ profiler() [1/2]

◆ profiler() [2/2]

◆ ~profiler()

Member Function Documentation

◆ copy()

◆ get_color()

◆ name()

◆ on_backward_prop_begin() [1/2]

◆ on_backward_prop_begin() [2/2]

◆ on_backward_prop_end() [1/2]

◆ on_backward_prop_end() [2/2]

◆ on_batch_begin()

◆ on_batch_end()

◆ on_batch_evaluate_begin()

◆ on_batch_evaluate_end()

◆ on_epoch_begin()

◆ on_epoch_end()

◆ on_evaluate_forward_prop_begin() [1/2]

◆ on_evaluate_forward_prop_begin() [2/2]

◆ on_evaluate_forward_prop_end() [1/2]

◆ on_evaluate_forward_prop_end() [2/2]

◆ on_forward_prop_begin() [1/2]

◆ on_forward_prop_begin() [2/2]

◆ on_forward_prop_end() [1/2]

◆ on_forward_prop_end() [2/2]

◆ on_optimize_begin() [1/2]

◆ on_optimize_begin() [2/2]

◆ on_optimize_end() [1/2]

◆ on_optimize_end() [2/2]

◆ on_test_begin()

◆ on_test_end()

◆ on_validation_begin()

◆ on_validation_end()

◆ operator=()

◆ serialize()

◆ write_specific_proto()

Member Data Documentation

◆ m_skip_init

◆ m_sync