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

#include <check_dataset.hpp>

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

Public Member Functions

 check_dataset ()
 
 check_dataset (const check_dataset &)=default
 
check_datasetoperator= (const check_dataset &)=default
 
check_datasetcopy () const override
 
void on_forward_prop_end (model *m, Layer *l) override
 Called when a layer ends forward propagation. More...
 
void on_evaluate_forward_prop_end (model *m, Layer *l) override
 Called when a layer ends forward propagation for evaluation (validation / testing). More...
 
void on_epoch_end (model *m) override
 Called immediate after the end of each epoch. More...
 
void on_validation_end (model *m) override
 Called immediately after the end of validation. More...
 
void on_test_end (model *m) override
 Called immediately after the end of testing. More...
 
void add_to_set (model *m, Layer *l, int64_t step, std::set< long > &set)
 
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_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_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...
 
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
 

Private Attributes

std::string m_basename
 Basename for writing files. More...
 
std::set< long > training_set
 
std::set< long > validation_set
 
std::set< long > testing_set
 

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

Save the sample indices for each mini-batch to ordered set. Check to make sure that all samples were properly processed.

Definition at line 41 of file check_dataset.hpp.

Constructor & Destructor Documentation

◆ check_dataset() [1/2]

lbann::callback::check_dataset::check_dataset ( )
inline

Definition at line 47 of file check_dataset.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_dataset() [2/2]

lbann::callback::check_dataset::check_dataset ( const check_dataset )
default

Member Function Documentation

◆ add_to_set()

void lbann::callback::check_dataset::add_to_set ( model m,
Layer l,
int64_t  step,
std::set< long > &  set 
)
Here is the caller graph for this function:

◆ copy()

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

Implements lbann::callback_base.

Definition at line 50 of file check_dataset.hpp.

Here is the call graph for this function:

◆ name()

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

Return this callback's name.

Implements lbann::callback_base.

Definition at line 59 of file check_dataset.hpp.

Here is the call graph for this function:

◆ on_epoch_end()

void lbann::callback::check_dataset::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_evaluate_forward_prop_end()

void lbann::callback::check_dataset::on_evaluate_forward_prop_end ( model m,
Layer l 
)
overridevirtual

Called when a layer ends forward propagation for evaluation (validation / testing).

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_forward_prop_end()

void lbann::callback::check_dataset::on_forward_prop_end ( model m,
Layer l 
)
overridevirtual

Called when a layer ends forward propagation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ on_test_end()

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

◆ on_validation_end()

void lbann::callback::check_dataset::on_validation_end ( model m)
overridevirtual

Called immediately after the end of validation.

Reimplemented from lbann::callback_base.

Here is the caller graph for this function:

◆ operator=()

check_dataset& lbann::callback::check_dataset::operator= ( const check_dataset )
default
Here is the caller graph for this function:

◆ serialize()

template<class Archive >
void lbann::callback::check_dataset::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::check_dataset::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

◆ m_basename

std::string lbann::callback::check_dataset::m_basename
private

Basename for writing files.

Definition at line 75 of file check_dataset.hpp.

◆ testing_set

std::set<long> lbann::callback::check_dataset::testing_set
private

Definition at line 79 of file check_dataset.hpp.

◆ training_set

std::set<long> lbann::callback::check_dataset::training_set
private

Definition at line 77 of file check_dataset.hpp.

◆ validation_set

std::set<long> lbann::callback::check_dataset::validation_set
private

Definition at line 78 of file check_dataset.hpp.


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