saved_model_bundle_source_adapter.cc

/* Copyright 2016 Google Inc. All Rights Reserved.
 
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.
==============================================================================*/
 
#include "tensorflow_serving/servables/tensorflow/saved_model_bundle_source_adapter.h"
 
#include <memory>
#include <string>
#include <utility>
 
#include "tensorflow/core/lib/core/errors.h"
#include "tensorflow/core/platform/types.h"
#include "tensorflow_serving/resources/resource_util.h"
#include "tensorflow_serving/resources/resource_values.h"
#include "tensorflow_serving/resources/resources.pb.h"
#include "tensorflow_serving/servables/tensorflow/bundle_factory_util.h"
#include "tensorflow_serving/servables/tensorflow/file_acl.h"
#include "tensorflow_serving/servables/tensorflow/machine_learning_metadata.h"
#include "tensorflow_serving/servables/tensorflow/saved_model_bundle_factory.h"
#include "tensorflow_serving/servables/tensorflow/saved_model_warmup.h"
 
namespace tensorflow {
namespace serving {
 
Status SavedModelBundleSourceAdapter::Create(
    const SavedModelBundleSourceAdapterConfig& config,
    std::unique_ptr<SavedModelBundleSourceAdapter>* adapter) {
  std::unique_ptr<SavedModelBundleFactory> bundle_factory;
  TF_RETURN_IF_ERROR(
      SavedModelBundleFactory::Create(config.legacy_config(), &bundle_factory));
  adapter->reset(new SavedModelBundleSourceAdapter(std::move(bundle_factory)));
  return absl::OkStatus();
}
 
SavedModelBundleSourceAdapter::~SavedModelBundleSourceAdapter() { Detach(); }
 
SavedModelBundleSourceAdapter::SavedModelBundleSourceAdapter(
    std::unique_ptr<SavedModelBundleFactory> bundle_factory)
    : bundle_factory_(std::move(bundle_factory)) {}
 
SimpleLoader<SavedModelBundle>::CreatorVariant
SavedModelBundleSourceAdapter::GetServableCreator(
    std::shared_ptr<SavedModelBundleFactory> bundle_factory,
    const StoragePath& path) const {
  if (bundle_factory->config().enable_session_metadata()) {
    return [bundle_factory, path](const Loader::Metadata& metadata,
                                  std::unique_ptr<SavedModelBundle>* bundle) {
      TF_RETURN_IF_ERROR(RegisterModelRoot(metadata.servable_id, path));
      TF_RETURN_IF_ERROR(bundle_factory->CreateSavedModelBundleWithMetadata(
          metadata, path, bundle));
      MaybePublishMLMDStreamz(path, metadata.servable_id.name,
                              metadata.servable_id.version);
      if (bundle_factory->config().enable_model_warmup()) {
        bundle_factory->mutable_config()
            .mutable_model_warmup_options()
            ->set_model_name(metadata.servable_id.name);
        bundle_factory->mutable_config()
            .mutable_model_warmup_options()
            ->set_model_version(metadata.servable_id.version);
        return RunSavedModelWarmup(
            bundle_factory->config().model_warmup_options(),
            GetRunOptions(bundle_factory->config()), path, bundle->get());
      }
      return absl::OkStatus();
    };
  }
  return [bundle_factory, path](std::unique_ptr<SavedModelBundle>* bundle) {
    TF_RETURN_IF_ERROR(bundle_factory->CreateSavedModelBundle(path, bundle));
    if (bundle_factory->config().enable_model_warmup()) {
      return RunSavedModelWarmup(
          bundle_factory->config().model_warmup_options(),
          GetRunOptions(bundle_factory->config()), path, bundle->get());
    }
    return absl::OkStatus();
  };
}
 
Status SavedModelBundleSourceAdapter::Convert(const StoragePath& path,
                                              std::unique_ptr<Loader>* loader) {
  std::shared_ptr<SavedModelBundleFactory> bundle_factory = bundle_factory_;
  auto servable_creator = GetServableCreator(bundle_factory, path);
  auto resource_estimator = [bundle_factory,
                             path](ResourceAllocation* estimate) {
    TF_RETURN_IF_ERROR(
        bundle_factory->EstimateResourceRequirement(path, estimate));
 
    // Add experimental_transient_ram_bytes_during_load.
    // TODO(b/38376838): Remove once resource estimates are moved inside
    // SavedModel.
    ResourceUtil::Options resource_util_options;
    resource_util_options.devices = {{device_types::kMain, 1}};
    std::unique_ptr<ResourceUtil> resource_util =
        std::unique_ptr<ResourceUtil>(new ResourceUtil(resource_util_options));
    const Resource ram_resource = resource_util->CreateBoundResource(
        device_types::kMain, resource_kinds::kRamBytes);
    resource_util->SetQuantity(
        ram_resource,
        resource_util->GetQuantity(ram_resource, *estimate) +
            bundle_factory->config()
                .experimental_transient_ram_bytes_during_load(),
        estimate);
 
    return absl::OkStatus();
  };
  auto post_load_resource_estimator = [bundle_factory,
                                       path](ResourceAllocation* estimate) {
    return bundle_factory->EstimateResourceRequirement(path, estimate);
  };
  loader->reset(new SimpleLoader<SavedModelBundle>(
      servable_creator, resource_estimator, {post_load_resource_estimator}));
  return absl::OkStatus();
}
 
// Register the source adapter.
class SavedModelBundleSourceAdapterCreator {
 public:
  static Status Create(
      const SavedModelBundleSourceAdapterConfig& config,
      std::unique_ptr<SourceAdapter<StoragePath, std::unique_ptr<Loader>>>*
          adapter) {
    std::unique_ptr<SavedModelBundleFactory> bundle_factory;
    TF_RETURN_IF_ERROR(SavedModelBundleFactory::Create(config.legacy_config(),
                                                       &bundle_factory));
    adapter->reset(
        new SavedModelBundleSourceAdapter(std::move(bundle_factory)));
    return absl::OkStatus();
  }
};
REGISTER_STORAGE_PATH_SOURCE_ADAPTER(SavedModelBundleSourceAdapterCreator,
                                     SavedModelBundleSourceAdapterConfig);
}  // namespace serving
}  // namespace tensorflow