#include <summary.hpp>

Inheritance diagram for lbann::callback::summary:

Collaboration diagram for lbann::callback::summary:

Public Member Functions
	summary (const std::shared_ptr< lbann_summary > &summarizer, int batch_interval=1, int mat_interval=25)

	summary (const summary &)=default

summary &	operator= (const summary &)=default

summary *	copy () const override

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

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

void	on_epoch_end (model *m) override
	Called immediate after the end of each epoch. 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...

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_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_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_validation_end (model *m)
	Called immediately after the end 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...

Protected Member Functions
void	save_histograms (model *m)

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...

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

Private Attributes
std::shared_ptr< lbann_summary >	m_summarizer = nullptr
	lbann_summary More...

int	m_mat_interval

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

Detailed Description

Summarize information to Tensorboard using LBANN's summary interface.

Definition at line 41 of file callbacks/summary.hpp.

Constructor & Destructor Documentation

◆ summary() [1/2]

lbann::callback::summary::summary	(	const std::shared_ptr< lbann_summary > &	summarizer,
		int	batch_interval = `1`,
		int	mat_interval = `25`
	)

Parameters

summarizer	The summary object to write to; this callback takes ownership of it.
batch_interval	The frequency with which to summarize
mat_interval	FIXME

Todo:: Document mat_interval parameter.

Here is the caller graph for this function:

◆ summary() [2/2]

lbann::callback::summary::summary ( const summary & )

default

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 56 of file callbacks/summary.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 61 of file callbacks/summary.hpp.

Here is the call graph for this function:

◆ on_batch_end()

void lbann::callback::summary::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_epoch_end()

void lbann::callback::summary::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::summary::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_train_begin()

void lbann::callback::summary::on_train_begin ( model * m )

overridevirtual

Called at the beginning of training.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ operator=()

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

default

◆ save_histograms()

void lbann::callback::summary::save_histograms ( model * m )

protected

Write out histograms from the model's layers.

Here is the caller graph for this function:

◆ write_specific_proto()

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

int lbann::callback::summary::m_mat_interval

private

Interval for doing matrix summarization.

Definition at line 75 of file callbacks/summary.hpp.

◆ m_summarizer

std::shared_ptr<lbann_summary> lbann::callback::summary::m_summarizer = nullptr

private

lbann_summary

Definition at line 72 of file callbacks/summary.hpp.

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

callbacks/summary.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ summary() [1/2]

◆ summary() [2/2]

Member Function Documentation

◆ copy()

◆ name()

◆ on_batch_end()

◆ on_epoch_end()

◆ on_test_end()

◆ on_train_begin()

◆ operator=()

◆ save_histograms()

◆ write_specific_proto()

Member Data Documentation

◆ m_mat_interval

◆ m_summarizer