Dump gradient matrices to files. More...

#include <dump_gradients.hpp>

Inheritance diagram for lbann::callback::dump_gradients:

Collaboration diagram for lbann::callback::dump_gradients:

Public Member Functions
	dump_gradients (std::string basename, int batch_interval=1)

	dump_gradients (const dump_gradients &)=default

dump_gradients &	operator= (const dump_gradients &)=default

dump_gradients *	copy () const override

void	on_backward_prop_end (model *m) override
	Called when a model ends backward 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_begin (model *m)
	Called at the beginning of each epoch. 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)
	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, 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

	dump_gradients ()

Private Attributes
std::string	m_basename
	Basename for writing files. More...

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

Dump gradient matrices to files.

This will dump each hidden layer's gradient matrix after each minibatch. The matrices are written to files using Elemental's simple ASCII format. This is not meant for checkpointing, but for exporting gradient matrices for analysis that isn't easily done in LBANN. Note this dumps matrices during each mini-batch. This will be slow and produce a lot of output.

Definition at line 48 of file dump_gradients.hpp.

Constructor & Destructor Documentation

◆ dump_gradients() [1/3]

lbann::callback::dump_gradients::dump_gradients	(	std::string	basename,
		int	batch_interval = `1`
	)

inline

Parameters

basename	The basename for writing files.
batch_interval	The frequency at which to dump the gradients

Definition at line 57 of file dump_gradients.hpp.

Here is the call graph for this function:

◆ dump_gradients() [2/3]

lbann::callback::dump_gradients::dump_gradients ( const dump_gradients & )

default

◆ dump_gradients() [3/3]

lbann::callback::dump_gradients::dump_gradients ( )

private

Here is the caller graph for this function:

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 62 of file dump_gradients.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 64 of file dump_gradients.hpp.

Here is the call graph for this function:

◆ on_backward_prop_end()

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

◆ operator=()

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

default

Here is the caller graph for this function:

◆ serialize()

template<class Archive >

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

Member Data Documentation

◆ m_basename

std::string lbann::callback::dump_gradients::m_basename

private

Basename for writing files.

Definition at line 83 of file dump_gradients.hpp.

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

dump_gradients.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dump_gradients() [1/3]

◆ dump_gradients() [2/3]

◆ dump_gradients() [3/3]

Member Function Documentation

◆ copy()

◆ name()

◆ on_backward_prop_end()

◆ operator=()

◆ serialize()

◆ write_specific_proto()

Friends And Related Function Documentation

◆ cereal::access

Member Data Documentation

◆ m_basename