1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_OPTIMIZATION_GUIDE_CORE_DELIVERY_MODEL_INFO_H_
#define COMPONENTS_OPTIMIZATION_GUIDE_CORE_DELIVERY_MODEL_INFO_H_
#include <memory>
#include <optional>
#include "base/containers/flat_map.h"
#include "base/containers/flat_set.h"
#include "base/files/file_path.h"
#include "components/optimization_guide/proto/models.pb.h"
namespace optimization_guide {
// Encapsulates information about a prediction model like its file path on disk
// and other metadata.
//
// Testing: This class is created by OptGuide code in production and isn't meant
// to be created by external consumers except for testing. For that purpose, use
// |TestModelInfoBuilder|.
class ModelInfo {
public:
// Validates and creates a ModelInfo if valid.
static std::unique_ptr<ModelInfo> Create(const proto::PredictionModel& model);
~ModelInfo();
ModelInfo(const ModelInfo&);
// Returns the version of the model file.
int64_t GetVersion() const;
// Returns the absolute file path where the model file is stored. This is the
// file that should be loaded into the TFLite Interpreter.
base::FilePath GetModelFilePath() const;
// Returns a set of absolute file paths of any additional files that were
// packaged along with the model.
base::flat_set<base::FilePath> GetAdditionalFiles() const;
// Returns the absolute file path of any additional files that were packaged
// along with the model based on `base_name`.
std::optional<base::FilePath> GetAdditionalFileWithBaseName(
const base::FilePath::StringType& base_name) const;
// Returns the metadata that the server provided specific to this model, if
// applicable.
std::optional<proto::Any> GetModelMetadata() const;
private:
ModelInfo(const base::FilePath& model_file_path,
const base::flat_map<base::FilePath::StringType, base::FilePath>&
additional_files,
const int64_t version,
const std::optional<proto::Any>& model_metadata);
base::FilePath model_file_path_;
base::flat_map<base::FilePath::StringType, base::FilePath> additional_files_;
int64_t version_;
std::optional<proto::Any> model_metadata_;
};
} // namespace optimization_guide
#endif // COMPONENTS_OPTIMIZATION_GUIDE_CORE_DELIVERY_MODEL_INFO_H_
|
