LBANN  0.103.0
LivermoreBigArtificialNeuralNetworkToolkit
lbann::callback::perturb_dropout Class Reference

Hyperparameter exploration with dropouts. More...

#include <perturb_dropout.hpp>

Inheritance diagram for lbann::callback::perturb_dropout:
[legend]
Collaboration diagram for lbann::callback::perturb_dropout:
[legend]

Public Member Functions

 perturb_dropout (EvalType keep_prob_factor, std::set< std::string > layer_names=std::set< std::string >())
 
perturb_dropoutcopy () 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...
 
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_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)
 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_dropout ()
 
template<typename TensorDataType , data_layout T_layout, El::Device Dev>
dropout< TensorDataType, T_layout, Dev > * get_dropout_layer (Layer *l)
 
void perturb (model &m)
 

Private Attributes

EvalType m_keep_prob_factor
 
std::set< std::string > m_layer_names
 

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_baseoperator= (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

Hyperparameter exploration with dropouts.

Goes through the dropout layers in a model and perturbs keep probability

Definition at line 41 of file perturb_dropout.hpp.

Constructor & Destructor Documentation

◆ perturb_dropout() [1/2]

lbann::callback::perturb_dropout::perturb_dropout ( EvalType  keep_prob_factor,
std::set< std::string >  layer_names = std::set< std::string >() 
)
Parameters
keep_prob_factorStandard deviation of learning rate perturbation (in log space).
layer_namesNames of layers with dropout keep prob to perturb. If empty, all dropout layers in the model are perturbed.

◆ perturb_dropout() [2/2]

lbann::callback::perturb_dropout::perturb_dropout ( )
private
Here is the caller graph for this function:

Member Function Documentation

◆ copy()

perturb_dropout* lbann::callback::perturb_dropout::copy ( ) const
inlineoverridevirtual

Implements lbann::callback_base.

Definition at line 52 of file perturb_dropout.hpp.

Here is the call graph for this function:

◆ get_dropout_layer()

template<typename TensorDataType , data_layout T_layout, El::Device Dev>
dropout<TensorDataType, T_layout, Dev>* lbann::callback::perturb_dropout::get_dropout_layer ( Layer l)
private

◆ name()

std::string lbann::callback::perturb_dropout::name ( ) const
inlineoverridevirtual

Return this callback's name.

Implements lbann::callback_base.

Definition at line 53 of file perturb_dropout.hpp.

Here is the call graph for this function:

◆ perturb()

void lbann::callback::perturb_dropout::perturb ( model m)
private

Perturb dropout keep prob in model.

◆ serialize()

template<class Archive >
void lbann::callback::perturb_dropout::serialize ( Archive &  ar)

Store state to archive for checkpoint and restart.

Here is the caller graph for this function:

◆ setup()

void lbann::callback::perturb_dropout::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_dropout::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 70 of file perturb_dropout.hpp.

Member Data Documentation

◆ m_keep_prob_factor

EvalType lbann::callback::perturb_dropout::m_keep_prob_factor
private

Standard deviation of keep probability perturbation.

In log space.

Definition at line 77 of file perturb_dropout.hpp.

◆ m_layer_names

std::set<std::string> lbann::callback::perturb_dropout::m_layer_names
private

Keep prob for these layers will be perturbed.

If empty, all dropout layers in the model will be perturbed.

Definition at line 83 of file perturb_dropout.hpp.


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