LBANN  0.103.0
LivermoreBigArtificialNeuralNetworkToolkit
lbann::ltfb::LTFBExecutionContext Class Referencefinal

#include <execution_context.hpp>

Inheritance diagram for lbann::ltfb::LTFBExecutionContext:
[legend]
Collaboration diagram for lbann::ltfb::LTFBExecutionContext:
[legend]

Public Member Functions

 LTFBExecutionContext ()=default
 
 ~LTFBExecutionContext ()=default
 
std::unique_ptr< lbann::ExecutionContextget_new () const override
 
std::string get_type () const override
 Get a string identifying the type of execution context. More...
 
std::string get_state_string () const noexcept override
 Return the state of the execution context as a string. More...
 
Checkpointing and Serialization
template<class Archive >
void serialize (Archive &ar)
 
void save_to_checkpoint_shared (persist &p) override
 Checkpoint exection_context to a shared checkpoint. More...
 
void load_from_checkpoint_shared (persist &p) override
 Restore execution_context from a shared checkpoint. More...
 
void save_to_checkpoint_distributed (persist &p) override
 Checkpoint exection_context to a distributed checkpoint. More...
 
void load_from_checkpoint_distributed (persist &p) override
 Restore execution_context from a distributed checkpoint. More...
 
- Public Member Functions inherited from lbann::ExecutionContext
 ExecutionContext ()
 
virtual ~ExecutionContext ()=default
 
virtual execution_mode get_execution_mode () const noexcept
 
size_t get_step () const noexcept
 Current step in the training algorithm. More...
 
void inc_step () noexcept
 Increment the current step in the training algorithm. More...
 
template<class Archive >
void serialize (Archive &ar)
 

Additional Inherited Members

- Protected Member Functions inherited from lbann::ExecutionContext
 ExecutionContext (const ExecutionContext &other)=delete
 
ExecutionContextoperator= (const ExecutionContext &other)=delete
 
 ExecutionContext (ExecutionContext &&other)=default
 
ExecutionContextoperator= (ExecutionContext &&other)=default
 

Detailed Description

Definition at line 47 of file ltfb/execution_context.hpp.

Constructor & Destructor Documentation

◆ LTFBExecutionContext()

lbann::ltfb::LTFBExecutionContext::LTFBExecutionContext ( )
default

◆ ~LTFBExecutionContext()

lbann::ltfb::LTFBExecutionContext::~LTFBExecutionContext ( )
default

Member Function Documentation

◆ get_new()

std::unique_ptr<lbann::ExecutionContext> lbann::ltfb::LTFBExecutionContext::get_new ( ) const
inlineoverridevirtual

Get a "clean" execution_context of the same type.

Implements lbann::ExecutionContext.

Definition at line 54 of file ltfb/execution_context.hpp.

◆ get_state_string()

std::string lbann::ltfb::LTFBExecutionContext::get_state_string ( ) const
inlineoverridevirtualnoexcept

Return the state of the execution context as a string.

Implements lbann::ExecutionContext.

Definition at line 66 of file ltfb/execution_context.hpp.

Here is the call graph for this function:

◆ get_type()

std::string lbann::ltfb::LTFBExecutionContext::get_type ( ) const
inlineoverridevirtual

Get a string identifying the type of execution context.

Should match the training algorithm.

Todo:
Absorb completely into get_state_string().

Implements lbann::ExecutionContext.

Definition at line 63 of file ltfb/execution_context.hpp.

Here is the caller graph for this function:

◆ load_from_checkpoint_distributed()

void lbann::ltfb::LTFBExecutionContext::load_from_checkpoint_distributed ( persist p)
inlineoverridevirtual

Restore execution_context from a distributed checkpoint.

Implements lbann::ExecutionContext.

Definition at line 94 of file ltfb/execution_context.hpp.

◆ load_from_checkpoint_shared()

void lbann::ltfb::LTFBExecutionContext::load_from_checkpoint_shared ( persist p)
inlineoverridevirtual

Restore execution_context from a shared checkpoint.

Implements lbann::ExecutionContext.

Definition at line 84 of file ltfb/execution_context.hpp.

◆ save_to_checkpoint_distributed()

void lbann::ltfb::LTFBExecutionContext::save_to_checkpoint_distributed ( persist p)
inlineoverridevirtual

Checkpoint exection_context to a distributed checkpoint.

Implements lbann::ExecutionContext.

Definition at line 89 of file ltfb/execution_context.hpp.

◆ save_to_checkpoint_shared()

void lbann::ltfb::LTFBExecutionContext::save_to_checkpoint_shared ( persist p)
inlineoverridevirtual

Checkpoint exection_context to a shared checkpoint.

Implements lbann::ExecutionContext.

Definition at line 79 of file ltfb/execution_context.hpp.

◆ serialize()

template<class Archive >
void lbann::ltfb::LTFBExecutionContext::serialize ( Archive &  ar)

Archive for checkpoint and restart

Here is the caller graph for this function:

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