lbann::optimizer::GradientHelper Class Reference

Manage gradient information. More...

#include <optimizer.hpp>

Inheritance diagram for lbann::optimizer::GradientHelper:

Public Member Functions
virtual	~GradientHelper ()=default
optimizer_gradient_status	get_status () const noexcept
void	set_status (optimizer_gradient_status s) noexcept
virtual El::BaseDistMatrix &	gradient () noexcept=0
virtual El::BaseDistMatrix const &	gradient () const noexcept=0
virtual void	start_allreduce (lbann_comm &)=0
virtual void	complete_allreduce (lbann_comm &)=0
virtual void	clear ()=0

Private Attributes
optimizer_gradient_status	status_ = optimizer_gradient_status::cleared

Detailed Description

Manage gradient information.

Definition at line 216 of file optimizer.hpp.

Constructor & Destructor Documentation

~GradientHelper()

virtual lbann::optimizer::GradientHelper::~GradientHelper ( )

virtualdefault

Member Function Documentation

clear()

virtual void lbann::optimizer::GradientHelper::clear ( )

pure virtual

Implemented in lbann::optimizer::GradientHelperImpl< TensorDataType >.

complete_allreduce()

virtual void lbann::optimizer::GradientHelper::complete_allreduce ( lbann_comm &  )

pure virtual

Implemented in lbann::optimizer::GradientHelperImpl< TensorDataType >.

get_status()

optimizer_gradient_status lbann::optimizer::GradientHelper::get_status ( ) const

inlinenoexcept

Definition at line 220 of file optimizer.hpp.

gradient() [1/2]

virtual El::BaseDistMatrix& lbann::optimizer::GradientHelper::gradient ( )

pure virtualnoexcept

Implemented in lbann::optimizer::GradientHelperImpl< TensorDataType >.

gradient() [2/2]

virtual El::BaseDistMatrix const& lbann::optimizer::GradientHelper::gradient ( ) const

pure virtualnoexcept

Implemented in lbann::optimizer::GradientHelperImpl< TensorDataType >.

set_status()

void lbann::optimizer::GradientHelper::set_status ( optimizer_gradient_status  s )

inlinenoexcept

Definition at line 221 of file optimizer.hpp.

start_allreduce()

virtual void lbann::optimizer::GradientHelper::start_allreduce ( lbann_comm &  )

pure virtual

Implemented in lbann::optimizer::GradientHelperImpl< TensorDataType >.

Member Data Documentation

status_

optimizer_gradient_status lbann::optimizer::GradientHelper::status_ = optimizer_gradient_status::cleared

private

Definition at line 229 of file optimizer.hpp.

---

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

• optimizer.hpp