training_algorithm.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_TRAINING_ALGORITHM_HPP_INCLUDED
#define LBANN_EXECUTION_ALGORITHMS_TRAINING_ALGORITHM_HPP_INCLUDED

#include "lbann/base.hpp"
#include "lbann/utils/cloneable.hpp"
#include "lbann/utils/make_abstract.hpp"
#include "lbann/utils/memory.hpp"
#include <google/protobuf/message.h>
#include <memory>

namespace lbann {

// Forward-declarations
class data_coordinator;
class ExecutionContext;
class model;

class TrainingAlgorithm
{
public:

  TrainingAlgorithm(std::string name);
  virtual ~TrainingAlgorithm() = default;


  virtual std::string get_type() const = 0;

  std::string const& get_name() const noexcept;



  virtual void apply(ExecutionContext& context,
                     model& model,
                     data_coordinator& dc,
                     execution_mode mode) = 0;

  void apply(model& model, data_coordinator& dc)
  {
    apply(*get_new_execution_context(), model, dc, execution_mode::training);
  }

  void setup_models(std::vector<observer_ptr<model>> const& models,
                    size_t max_mini_batch_size,
                    const std::vector<El::Grid*>& grids);

  std::unique_ptr<ExecutionContext> get_new_execution_context() const
  {
    return to_unique_ptr(do_get_new_execution_context());
  }

protected:
  TrainingAlgorithm(const TrainingAlgorithm& other) = delete;
  TrainingAlgorithm& operator=(const TrainingAlgorithm& other) = delete;
  TrainingAlgorithm(TrainingAlgorithm&& other) = default;
  TrainingAlgorithm& operator=(TrainingAlgorithm&& other) = default;

  virtual ExecutionContext* do_get_new_execution_context() const = 0;

private:
  std::string m_name;
};

} // namespace lbann

#endif // LBANN_EXECUTION_ALGORITHMS_TRAINING_ALGORITHM_HPP_INCLUDED