mindspore2022/mindspore/ccsrc/ps/server/model_store.h

/**
 * Copyright 2021 Huawei Technologies Co., Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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 MINDSPORE_CCSRC_PS_SERVER_MODEL_STORE_H_
#define MINDSPORE_CCSRC_PS_SERVER_MODEL_STORE_H_

#include <map>
#include <memory>
#include <string>
#include "ps/server/common.h"
#include "ps/server/memory_register.h"
#include "ps/server/executor.h"

namespace mindspore {
namespace ps {
namespace server {
// The initial iteration number is 0 in server.
constexpr size_t kInitIterationNum = 0;

// Server framework use ModelStore to store and query models.
// ModelStore stores multiple models because worker could get models of the previous iterations.
class ModelStore {
 public:
  static ModelStore &GetInstance() {
    static ModelStore instance;
    return instance;
  }

  // Initialize ModelStore with max count of models need to be stored.
  void Initialize(uint32_t max_count = 3);

  // Store the model of the given iteration. The model is acquired from Executor. If the current model count is already
  // max_model_count_, the earliest model will be replaced.
  bool StoreModelByIterNum(size_t iteration, const std::map<std::string, AddressPtr> &model);

  // Get model of the given iteration.
  std::map<std::string, AddressPtr> GetModelByIterNum(size_t iteration);

  // Returns all models stored in ModelStore.
  const std::map<size_t, std::shared_ptr<MemoryRegister>> &iteration_to_model() const;

  // Returns the model size, which could be calculated at the initializing phase.
  size_t model_size() const;

 private:
  ModelStore() : max_model_count_(0), model_size_(0), iteration_to_model_({}) {}
  ~ModelStore() = default;
  ModelStore(const ModelStore &) = delete;
  ModelStore &operator=(const ModelStore &) = delete;

  // To store multiple models, new memory must assigned. The max memory size assigned for models is max_model_count_ *
  // model_size_.
  std::shared_ptr<MemoryRegister> AssignNewModelMemory();

  // Calculate the model size. This method should be called after iteration_to_model_ is initialized.
  size_t ComputeModelSize();

  size_t max_model_count_;
  size_t model_size_;
  std::map<size_t, std::shared_ptr<MemoryRegister>> iteration_to_model_;
};
}  // namespace server
}  // namespace ps
}  // namespace mindspore
#endif  // MINDSPORE_CCSRC_PS_SERVER_MODEL_STORE_H_