#include <alternate_updates.hpp>

Inheritance diagram for lbann::callback::alternate_updates:

Collaboration diagram for lbann::callback::alternate_updates:

Public Member Functions
	alternate_updates (std::vector< std::string > layers_1, std::vector< std::string > layers_2, int iters_1=1, int iters_2=1)

	alternate_updates (const alternate_updates &)=default

alternate_updates &	operator= (const alternate_updates &)=default

alternate_updates *	copy () const override

void	setup (model *m) override
	Called once to set up the callback on the model (after all layers are set up). More...

void	on_batch_begin (model *m) override
	Called at the beginning of a (mini-)batch. 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	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_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)
	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
	Add callback specific data to prototext. More...

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

std::vector< std::string >	m_layer_names_2

std::vector< Layer * >	freeze_layers

std::vector< Layer * >	unfreeze_layers

int	m_iters_1

int	m_iters_tot

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

Alternate layer/weight updates to support training networks like GANs. Takes lists of layers to freeze and unfreeze in an alternating fashion. Supports a separate number of updates for each set of layers between freezing and unfreezing.

Definition at line 44 of file alternate_updates.hpp.

Constructor & Destructor Documentation

◆ alternate_updates() [1/2]

lbann::callback::alternate_updates::alternate_updates	(	std::vector< std::string >	layers_1,
		std::vector< std::string >	layers_2,
		int	iters_1 = `1`,
		int	iters_2 = `1`
	)

inline

Definition at line 47 of file alternate_updates.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ alternate_updates() [2/2]

lbann::callback::alternate_updates::alternate_updates ( const alternate_updates & )

default

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 60 of file alternate_updates.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 66 of file alternate_updates.hpp.

Here is the call graph for this function:

◆ on_batch_begin()

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

◆ operator=()

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

default

Here is the caller graph for this function:

◆ setup()

void lbann::callback::alternate_updates::setup ( model * m )

overridevirtual

Called once to set up the callback on the model (after all layers are set up).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ write_specific_proto()

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

◆ freeze_layers

std::vector<Layer*> lbann::callback::alternate_updates::freeze_layers

private

Definition at line 71 of file alternate_updates.hpp.

◆ m_iters_1

int lbann::callback::alternate_updates::m_iters_1

private

Definition at line 72 of file alternate_updates.hpp.

◆ m_iters_tot

int lbann::callback::alternate_updates::m_iters_tot

private

Definition at line 72 of file alternate_updates.hpp.

◆ m_layer_names_1

std::vector<std::string> lbann::callback::alternate_updates::m_layer_names_1

private

Definition at line 70 of file alternate_updates.hpp.

◆ m_layer_names_2

std::vector<std::string> lbann::callback::alternate_updates::m_layer_names_2

private

Definition at line 70 of file alternate_updates.hpp.

◆ unfreeze_layers

std::vector<Layer*> lbann::callback::alternate_updates::unfreeze_layers

private

Definition at line 71 of file alternate_updates.hpp.

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

alternate_updates.hpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ alternate_updates() [1/2]

◆ alternate_updates() [2/2]

Member Function Documentation

◆ copy()

◆ name()

◆ on_batch_begin()

◆ operator=()

◆ setup()

◆ write_specific_proto()

Member Data Documentation

◆ freeze_layers

◆ m_iters_1

◆ m_iters_tot

◆ m_layer_names_1

◆ m_layer_names_2

◆ unfreeze_layers