Perturb values in a weights tensor. More...

#include <perturb_weights.hpp>

Inheritance diagram for lbann::callback::perturb_weights:

Collaboration diagram for lbann::callback::perturb_weights:

Public Member Functions
	perturb_weights (EvalType upper, EvalType lower, EvalType scale, EvalType perturb_probability, std::string output_name, El::Int batch_interval=1)

perturb_weights *	copy () const override

std::string	name () const override
	Return this callback's name. More...

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

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

	perturb_weights ()

void	perturb (model &m)

Private Attributes
std::string	m_output_name
	Name of weights being perturbed. More...

EvalType	m_upper
	Upper bound for weights values. More...

EvalType	m_lower
	Lower bound for weights values. More...

EvalType	m_scale
	Standard deviation of normal perturbations. More...

EvalType	m_perturb_probability
	Probability of applying perturbation to a given value. 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

Perturb values in a weights tensor.

Each entry of the weights tensor has a probability of being perturbed by a normal random number. The resulting values are clamped within a range.

Definition at line 42 of file perturb_weights.hpp.

Constructor & Destructor Documentation

◆ perturb_weights() [1/2]

lbann::callback::perturb_weights::perturb_weights	(	EvalType	upper,
		EvalType	lower,
		EvalType	scale,
		EvalType	perturb_probability,
		std::string	output_name,
		El::Int	batch_interval = `1`
	)

Parameters

batch_interval	Number of training mini-batch steps between perturbations
output_name	Name of weights being perturbed
upper	Upper bound for weights values
lower	Lower bound for weights values
scale	Standard deviation of normal perturbations
perturb_probability	Probability of applying perturbation to a given weights value

◆ perturb_weights() [2/2]

lbann::callback::perturb_weights::perturb_weights ( )

private

Here is the caller graph for this function:

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 62 of file perturb_weights.hpp.

Here is the call graph for this function:

◆ name()

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

inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 63 of file perturb_weights.hpp.

Here is the call graph for this function:

◆ on_batch_begin()

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

◆ perturb()

void lbann::callback::perturb_weights::perturb ( model & m )

private

◆ serialize()

template<class Archive >

void lbann::callback::perturb_weights::serialize ( Archive & ar )

Store state to archive for checkpoint and restart.

Here is the caller graph for this function:

◆ setup()

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

Member Data Documentation

◆ m_lower

EvalType lbann::callback::perturb_weights::m_lower

private

Lower bound for weights values.

Definition at line 90 of file perturb_weights.hpp.

◆ m_output_name

std::string lbann::callback::perturb_weights::m_output_name

private

Name of weights being perturbed.

Definition at line 85 of file perturb_weights.hpp.

◆ m_perturb_probability

EvalType lbann::callback::perturb_weights::m_perturb_probability

private

Probability of applying perturbation to a given value.

Definition at line 94 of file perturb_weights.hpp.

◆ m_scale

EvalType lbann::callback::perturb_weights::m_scale

private

Standard deviation of normal perturbations.

Definition at line 92 of file perturb_weights.hpp.

◆ m_upper

EvalType lbann::callback::perturb_weights::m_upper

private

Upper bound for weights values.

Definition at line 88 of file perturb_weights.hpp.

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

perturb_weights.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ perturb_weights() [1/2]

◆ perturb_weights() [2/2]

Member Function Documentation

◆ copy()

◆ name()

◆ on_batch_begin()

◆ perturb()

◆ serialize()

◆ setup()

◆ write_specific_proto()

Friends And Related Function Documentation

◆ cereal::access

Member Data Documentation

◆ m_lower

◆ m_output_name

◆ m_perturb_probability

◆ m_scale

◆ m_upper