lbann::BatchTerminationCriteria Class Reference

Stop SGD based on a fixed batch count. More...

#include <sgd_execution_context.hpp>

Inheritance diagram for lbann::BatchTerminationCriteria:

Collaboration diagram for lbann::BatchTerminationCriteria:

Public Member Functions
	BatchTerminationCriteria (size_t num_batches)
Public Member Functions inherited from lbann::Cloneable< BatchTerminationCriteria, SGDTerminationCriteria >
std::unique_ptr< BatchTerminationCriteria >	clone () const
	Return an exception-safe, memory-safe copy of this object. More...

Private Member Functions
bool	is_done (SGDExecutionContext const &c) const noexcept final

Private Attributes
size_t	m_max_batches

Detailed Description

Stop SGD based on a fixed batch count.

The training algorithm still tracks the epoch count for other parts of the code (e.g. at_epoch_begin/end callbacks).

Definition at line 157 of file sgd_execution_context.hpp.

Constructor & Destructor Documentation

BatchTerminationCriteria()

lbann::BatchTerminationCriteria::BatchTerminationCriteria ( size_t  num_batches )

inline

Definition at line 161 of file sgd_execution_context.hpp.

Member Function Documentation

is_done()

bool lbann::BatchTerminationCriteria::is_done ( SGDExecutionContext const &  c ) const

inlinefinalprivatenoexcept

Definition at line 164 of file sgd_execution_context.hpp.

Member Data Documentation

m_max_batches

size_t lbann::BatchTerminationCriteria::m_max_batches

private

Definition at line 170 of file sgd_execution_context.hpp.

---

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

• sgd_execution_context.hpp