callback.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.
//
// callback .hpp - Base class for LBANN callbacks

#ifndef LBANN_CALLBACKS_CALLBACK_HPP_INCLUDED
#define LBANN_CALLBACKS_CALLBACK_HPP_INCLUDED

#include "lbann/utils/description.hpp"
#include "lbann/utils/memory.hpp"
#include "lbann/utils/summary.hpp"

#include <google/protobuf/message.h>

#include <algorithm>
#include <string>

// Forward-declare protobuf classes
namespace lbann_data {
class Callback;
}

#define LBANN_ADD_DEFAULT_CALLBACK_BUILDER(Class, FunctionName)                \
  inline std::unique_ptr<callback_base> FunctionName(                          \
    const google::protobuf::Message&,                                          \
    std::shared_ptr<lbann_summary> const&)                                     \
  {                                                                            \
    return std::make_unique<Class>();                                          \
  }

namespace cereal {
class access;
} // namespace cereal

namespace lbann {

// Forward-declarations
class Layer;
class model;
class trainer;
class weights;

class callback_base
{
public:

  callback_base(int batch_interval = 1)
    : m_batch_interval(std::max(batch_interval, 1))
  {}
  callback_base(const callback_base&) = default;
  virtual ~callback_base() = default;



  virtual callback_base* copy() const = 0;



  virtual void setup(trainer* t){};

  virtual void setup(model* m){};



  virtual void on_setup_end(model* m) {}
  virtual void on_train_begin(model* m) {}
  virtual void on_train_end(model* m) {}
  virtual void on_phase_end(model* m) {}
  virtual void on_epoch_begin(model* m) {}
  virtual void on_epoch_end(model* m) {}
  virtual void on_batch_begin(model* m) {}
  virtual void on_batch_end(model* m) {}
  virtual void on_test_begin(model* m) {}
  virtual void on_test_end(model* m) {}
  virtual void on_validation_begin(model* m) {}
  virtual void on_validation_end(model* m) {}
  virtual void on_forward_prop_begin(model* m) {}
  virtual void on_forward_prop_begin(model* m, Layer* l) {}
  virtual void on_forward_prop_end(model* m) {}
  virtual void on_forward_prop_end(model* m, Layer* l) {}
  virtual void on_backward_prop_begin(model* m) {}
  virtual void on_backward_prop_begin(model* m, Layer* l) {}
  virtual void on_backward_prop_end(model* m) {}
  virtual void on_backward_prop_end(model* m, Layer* l) {}
  virtual void on_optimize_begin(model* m) {}
  virtual void on_optimize_begin(model* m, weights* w) {}
  virtual void on_optimize_end(model* m) {}
  virtual void on_optimize_end(model* m, weights* w) {}

  virtual void on_batch_evaluate_begin(model* m) {}
  virtual void on_batch_evaluate_end(model* m) {}
  virtual void on_evaluate_forward_prop_begin(model* m) {}
  virtual void on_evaluate_forward_prop_begin(model* m, Layer* l) {}
  virtual void on_evaluate_forward_prop_end(model* m) {}
  virtual void on_evaluate_forward_prop_end(model* m, Layer* l) {}



  int get_batch_interval() const { return m_batch_interval; }

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

  virtual description get_description() const;



  template <class Archive>
  void serialize(Archive& ar);

  void write_proto(lbann_data::Callback& proto) const;

protected:
  virtual void write_specific_proto(lbann_data::Callback& proto) const = 0;


  std::string get_multi_trainer_path(const model& m,
                                     const std::string& root_dir);

  std::string get_multi_trainer_ec_model_path(const model& m,
                                              const std::string& root_dir);

  std::string get_multi_trainer_model_path(const model& m,
                                           const std::string& root_dir);

protected:
  callback_base& operator=(const callback_base&) = default;

protected:
  int m_batch_interval;
};

} // namespace lbann

#endif // LBANN_CALLBACKS_CALLBACK_HPP_INCLUDED