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

#include <load_model.hpp>

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

Public Member Functions

 load_model (std::vector< std::string > dirs, std::string extension="prototext")
 
 load_model (const load_model &)=default
 
load_modeloperator= (const load_model &)=default
 
load_modelcopy () const override
 
void add_dir (const std::string &dir)
 
void on_train_begin (model *m) override
 Called at the beginning of training. More...
 
void on_test_begin (model *m) override
 Called at the beginning 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_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_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

 load_model ()=default
 
void write_specific_proto (lbann_data::Callback &proto) const final
 

Private Attributes

std::vector< std::string > m_dirs
 
std::string m_extension
 Disables the normal behavior of saving when training is complete. More...
 
bool m_loaded
 Flag to indicate if the model has already been loaded. More...
 

Friends

class lbann::model
 
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

Load pretrained model from file

Definition at line 49 of file load_model.hpp.

Constructor & Destructor Documentation

◆ load_model() [1/3]

lbann::callback::load_model::load_model ( std::vector< std::string >  dirs,
std::string  extension = "prototext" 
)
inline
Parameters
dirsdirectories from which to load model
extensionfile extension e.g., model, state ......

Definition at line 56 of file load_model.hpp.

◆ load_model() [2/3]

lbann::callback::load_model::load_model ( const load_model )
default

◆ load_model() [3/3]

lbann::callback::load_model::load_model ( )
privatedefault

Member Function Documentation

◆ add_dir()

void lbann::callback::load_model::add_dir ( const std::string &  dir)
inline

Definition at line 66 of file load_model.hpp.

◆ copy()

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

Implements lbann::callback_base.

Definition at line 64 of file load_model.hpp.

◆ name()

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

Return this callback's name.

Implements lbann::callback_base.

Definition at line 72 of file load_model.hpp.

Here is the call graph for this function:

◆ on_test_begin()

void lbann::callback::load_model::on_test_begin ( model m)
overridevirtual

Called at the beginning of testing.

Reimplemented from lbann::callback_base.

◆ on_train_begin()

void lbann::callback::load_model::on_train_begin ( model m)
overridevirtual

Called at the beginning of training.

Reimplemented from lbann::callback_base.

◆ operator=()

load_model& lbann::callback::load_model::operator= ( const load_model )
default

◆ serialize()

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

Store state to archive for checkpoint and restart.

◆ write_specific_proto()

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

◆ lbann::model

friend class lbann::model
friend

Definition at line 84 of file load_model.hpp.

Member Data Documentation

◆ m_dirs

std::vector<std::string> lbann::callback::load_model::m_dirs
private

Definition at line 92 of file load_model.hpp.

◆ m_extension

std::string lbann::callback::load_model::m_extension
private

Disables the normal behavior of saving when training is complete.

Definition at line 94 of file load_model.hpp.

◆ m_loaded

bool lbann::callback::load_model::m_loaded
private

Flag to indicate if the model has already been loaded.

Definition at line 97 of file load_model.hpp.


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