execution_algorithms/ltfb.hpp

Go to the documentation of this file.

// Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the LBANN Research Team (B. Van Essen, et al.) listed in
// the CONTRIBUTORS file. <lbann-dev@llnl.gov>
//
// LLNL-CODE-697807.
// All rights reserved.
//
// This file is part of LBANN: Livermore Big Artificial Neural Network
// Toolkit. For details, see http://software.llnl.gov/LBANN or
// https://github.com/LLNL/LBANN.
//
// Licensed under the Apache License, Version 2.0 (the "Licensee"); you
// may not use this file except in compliance with the License.  You may
// obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the license.
#ifndef LBANN_EXECUTION_ALGORITHMS_LTFB_HPP_INCLUDED
#define LBANN_EXECUTION_ALGORITHMS_LTFB_HPP_INCLUDED

#include "lbann/data_coordinator/data_coordinator.hpp"
#include "lbann/execution_algorithms/factory.hpp"
#include "lbann/execution_algorithms/training_algorithm.hpp"
#include "lbann/trainers/trainer.hpp"
#include "lbann/utils/cloneable.hpp"
#include "lbann/utils/make_abstract.hpp"

#include "ltfb/execution_context.hpp"
#include "ltfb/meta_learning_strategy.hpp"
#include "ltfb/termination_criteria.hpp"

#include <google/protobuf/message.h>
#include <memory>

namespace lbann {

class LTFB final : public TrainingAlgorithm
{
public:
  using TermCriteriaType = ltfb::LTFBTerminationCriteria;
  using ExeContextType = ltfb::LTFBExecutionContext;

public:

  LTFB(std::string name,
       std::unique_ptr<TrainingAlgorithm> local_training_algorithm,
       std::unique_ptr<ltfb::MetaLearningStrategy> meta_learning_strategy,
       ltfb::LTFBTerminationCriteria stopping_criteria,
       bool suppress_timer)
    : TrainingAlgorithm{std::move(name)},
      m_local_algo{std::move(local_training_algorithm)},
      m_meta_learning_strategy{std::move(meta_learning_strategy)},
      m_termination_criteria{std::move(stopping_criteria)},
      m_suppress_timer{suppress_timer}
  {}

  ~LTFB() noexcept = default;
  LTFB(LTFB const& other) = delete;
  LTFB& operator=(LTFB const&) = delete;
  LTFB(LTFB&&) = default;
  LTFB& operator=(LTFB&&) = default;

  std::string get_type() const final { return "LTFB"; }


  void apply(ExecutionContext& context,
             model& m,
             data_coordinator& dc,
             execution_mode mode) final;
protected:
  ltfb::LTFBExecutionContext* do_get_new_execution_context() const final
  {
    return new ltfb::LTFBExecutionContext();
  }

private:
  std::unique_ptr<TrainingAlgorithm> m_local_algo;

  std::unique_ptr<ltfb::MetaLearningStrategy> m_meta_learning_strategy;

  ltfb::LTFBTerminationCriteria m_termination_criteria;

  bool m_suppress_timer = false;
}; // class LTFB

} // namespace lbann

template <>
std::unique_ptr<lbann::LTFB>
lbann::make<lbann::LTFB>(google::protobuf::Message const& msg);

#endif // LBANN_EXECUTION_ALGORITHMS_LTFB_HPP_INCLUDED