Public Member Functions |
Private Member Functions |
Private Attributes |
Friends |
List of all members
lbann::callback::early_stopping Class Reference
#include <early_stopping.hpp>
Inheritance diagram for lbann::callback::early_stopping:
Collaboration diagram for lbann::callback::early_stopping:
Public Member Functions | |
| early_stopping (int64_t patience) | |
| early_stopping (const early_stopping &)=default | |
| early_stopping & | operator= (const early_stopping &)=default |
| early_stopping * | copy () const override |
| void | on_validation_end (model *m) override |
| 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_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_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 |
| early_stopping () | |
Private Attributes | |
| int64_t | m_patience |
| EvalType | m_last_score = std::numeric_limits<EvalType>::max() |
| int64_t | m_wait = 0 |
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
Stop training after validation error stops improving.
Definition at line 42 of file early_stopping.hpp.
Constructor & Destructor Documentation
◆ early_stopping() [1/3]
| lbann::callback::early_stopping::early_stopping | ( | int64_t | patience | ) |
Continue training until score has not improved for patience epochs.
◆ early_stopping() [2/3]
|
default |
◆ early_stopping() [3/3]
|
private |
Here is the caller graph for this function:
Member Function Documentation
◆ copy()
|
inlineoverridevirtual |
Implements lbann::callback_base.
Definition at line 51 of file early_stopping.hpp.
Here is the call graph for this function:
◆ name()
|
inlineoverridevirtual |
Return this callback's name.
Implements lbann::callback_base.
Definition at line 54 of file early_stopping.hpp.
Here is the call graph for this function:
◆ on_validation_end()
|
overridevirtual |
Update validation score and check for early stopping.
Reimplemented from lbann::callback_base.
Here is the caller graph for this function:
◆ operator=()
|
default |
◆ serialize()
template<class Archive >
| void lbann::callback::early_stopping::serialize | ( | Archive & | ar | ) |
Store state to archive for checkpoint and restart.
Here is the caller graph for this function:
◆ write_specific_proto()
|
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 |
Definition at line 69 of file early_stopping.hpp.
Member Data Documentation
◆ m_last_score
|
private |
Last recorded score.
Definition at line 75 of file early_stopping.hpp.
◆ m_patience
|
private |
Number of epochs to wait for improvements.
Definition at line 73 of file early_stopping.hpp.
◆ m_wait
|
private |
Current number of epochs without improvement.
Definition at line 77 of file early_stopping.hpp.
The documentation for this class was generated from the following file:
