weights/weights.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_WEIGHTS_HPP
#define LBANN_WEIGHTS_HPP

#include "lbann/base.hpp"
#include "lbann/utils/cloneable.hpp"
#include "lbann/utils/description.hpp"

#include <memory>
#include <string>
#include <vector>
#ifdef LBANN_HAS_ONNX
#include <onnx/onnx_pb.h>
#endif // LBANN_HAS_ONNX

namespace lbann_data {
class Weights;
}

namespace lbann {

namespace Al {
// Forward declaration
struct request;
} // namespace Al

// Forward declaration
class lbann_comm;
class weights;
class weights_initializer;
class optimizer;

using OwningWeightsPtr = std::shared_ptr<weights>;
using ViewingWeightsPtr = std::weak_ptr<weights>;

class weights : public Cloneable<HasAbstractFunction<weights>>
{
private:
  weights();
  // -----------------------------------------------
  // Internal method for setting the comm pointer
  // -----------------------------------------------
  void set_comm(lbann_comm& comm);
  void setup_default_matrix_distribution();

public:
  weights(lbann_comm& comm);
  virtual ~weights() = default;

  void set_name(std::string name) { m_name = name; }

  std::string get_name() const { return m_name; }

  lbann_comm& get_comm() const { return *m_comm; }

  description get_description() const;

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

  virtual bool has_optimizer() const = 0;

  // -----------------------------------------------
  // Dimension accessors
  // -----------------------------------------------
  std::vector<size_t> get_dims() const;
  size_t get_size() const;
  std::vector<size_t> get_matrix_height_dims() const;
  std::vector<size_t> get_matrix_width_dims() const;
  size_t get_matrix_height() const;
  size_t get_matrix_width() const;
  void set_dims(std::vector<size_t> matrix_height_dims,
                std::vector<size_t> matrix_width_dims = {});
  void set_dims(size_t size) { set_dims({size}, {}); }

  // -----------------------------------------------
  // Matrix distribution accessors
  // -----------------------------------------------
  El::DistData get_matrix_distribution() const;
  void set_matrix_distribution(El::DistData dist);


  void set_values(El::BaseDistMatrix const& values);

  virtual El::BaseDistMatrix& get_values() = 0;
  virtual El::BaseDistMatrix const& get_values() const = 0;

  // -----------------------------------------------
  // Initializer accessors
  // -----------------------------------------------
  virtual weights_initializer* get_initializer() = 0;
  virtual const weights_initializer* get_initializer() const = 0;
  virtual void set_initializer(std::unique_ptr<weights_initializer>&& init) = 0;

  // -----------------------------------------------
  // Optimizer accessors
  // -----------------------------------------------
  virtual optimizer* get_optimizer() = 0;
  virtual const optimizer* get_optimizer() const = 0;
  virtual void set_optimizer(std::unique_ptr<optimizer>&& opt) = 0;

  // -----------------------------------------------
  // Setup
  // -----------------------------------------------
  void setup();

  // -----------------------------------------------
  // Freezing
  // -----------------------------------------------
  void freeze() { m_frozen = true; }
  void unfreeze() { m_frozen = false; }
  bool is_frozen() const { return m_frozen; }

  // -----------------------------------------------
  // Weight matrix accessors
  // -----------------------------------------------

  virtual void reconcile_values() = 0;
  virtual void reconcile_values(Al::request& req) = 0;

  virtual bool load_from_save(std::string const& ckpt_dir,
                              std::vector<std::string> const& weight_list) = 0;

  virtual void write_proto(lbann_data::Weights& proto) const = 0;


  template <typename ArchiveT>
  void serialize(ArchiveT& ar);

#ifdef LBANN_HAS_ONNX

  virtual void fill_onnx_node(onnx::GraphProto& graph) const = 0;
#endif // LBANN_HAS_ONNX



  void steal_values(weights& other);

protected:
  weights(const weights& other) = default;
  weights& operator=(const weights& other) = default;

private:
  virtual void do_augment_description_(description&) const = 0;
  virtual void do_setup_() = 0;

  virtual void do_set_dims_(std::vector<size_t> const& matrix_height_dims,
                            std::vector<size_t> const& matrix_width_dims) = 0;
  virtual void do_steal_values_(weights& other) = 0;

private:
  std::string m_name;

  lbann_comm* m_comm;

  std::vector<size_t> m_matrix_height_dims;
  std::vector<size_t> m_matrix_width_dims;
  El::DistData m_matrix_dist;

  bool m_frozen;
};

} // namespace lbann

#endif // LBANN_WEIGHTS_HPP