#include <save_images.hpp>

Inheritance diagram for lbann::callback::save_images:

Collaboration diagram for lbann::callback::save_images:

Public Member Functions
	save_images (std::vector< std::string > layer_names, std::string image_format="jpg", std::string image_prefix="")

	save_images (const save_images &)=default

save_images &	operator= (const save_images &)=default

save_images *	copy () const override

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

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

Private Member Functions
	save_images ()=default

void	write_specific_proto (lbann_data::Callback &proto) const final

Private Attributes
std::vector< std::string >	m_layer_names

std::string	m_image_format

std::string	m_image_prefix

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

Save layer outputs as image files. Image files are in the form "<prefix><tag>-<layer name>.<format>".

Definition at line 41 of file save_images.hpp.

Constructor & Destructor Documentation

◆ save_images() [1/3]

lbann::callback::save_images::save_images	(	std::vector< std::string >	layer_names,
		std::string	image_format = `"jpg"`,
		std::string	image_prefix = `""`
	)

Constructor.

Parameters

layer_names	List of layer names to save as images.
image_format	Image file format (e.g. jpg, png, pgm).
image_prefix	Prefix for image file names.

◆ save_images() [2/3]

lbann::callback::save_images::save_images ( const save_images & )

default

◆ save_images() [3/3]

lbann::callback::save_images::save_images ( )

privatedefault

Here is the caller graph for this function:

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 54 of file save_images.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 57 of file save_images.hpp.

Here is the call graph for this function:

◆ on_epoch_end()

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

◆ operator=()

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

default

◆ serialize()

template<class Archive >

void lbann::callback::save_images::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::save_images::write_specific_proto ( lbann_data::Callback & proto ) const

finalprivatevirtual

Add callback specific data to prototext

Implements lbann::callback_base.

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 69 of file save_images.hpp.

Member Data Documentation

◆ m_image_format

std::string lbann::callback::save_images::m_image_format

private

Image file format. Valid options: jpg, png, pgm.

Definition at line 81 of file save_images.hpp.

◆ m_image_prefix

std::string lbann::callback::save_images::m_image_prefix

private

Prefix for saved image files.

Definition at line 83 of file save_images.hpp.

◆ m_layer_names

std::vector<std::string> lbann::callback::save_images::m_layer_names

private

List of layer names to save as images.

Definition at line 77 of file save_images.hpp.

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

save_images.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ save_images() [1/3]

◆ save_images() [2/3]

◆ save_images() [3/3]

Member Function Documentation

◆ copy()

◆ name()

◆ on_epoch_end()

◆ on_test_end()

◆ operator=()

◆ serialize()

◆ write_specific_proto()

Friends And Related Function Documentation

◆ cereal::access

Member Data Documentation

◆ m_image_format

◆ m_image_prefix

◆ m_layer_names