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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/omnibox/browser/on_device_tail_model_service.h"
#include <optional>
#include <utility>
#include "base/command_line.h"
#include "base/containers/flat_set.h"
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/logging.h"
#include "base/memory/memory_pressure_monitor.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "components/omnibox/browser/on_device_tail_model_executor.h"
#include "components/optimization_guide/core/delivery/optimization_guide_model_provider.h"
#include "components/optimization_guide/core/optimization_guide_util.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "components/optimization_guide/proto/on_device_tail_suggest_model_metadata.pb.h"
namespace {
// Constants for TFlite model validation.
constexpr std::string kTestPrefix = "google m";
constexpr std::string_view kModelValidationSwitchName =
"omnibox-on-device-tail-model-validation";
void InitializeTailModelExecutor(
OnDeviceTailModelExecutor* executor,
const base::FilePath& model_file,
const base::flat_set<base::FilePath>& additional_files,
const optimization_guide::proto::OnDeviceTailSuggestModelMetadata&
metadata) {
if (executor == nullptr) {
return;
}
if (model_file.empty() || additional_files.empty()) {
return;
}
bool init_success = executor->Init(model_file, additional_files, metadata);
if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
kModelValidationSwitchName)) {
return;
}
// Histograms only for model validation.
LOCAL_HISTOGRAM_BOOLEAN("Omnibox.OnDeviceTailModel.InitExecutor",
init_success);
if (init_success) {
OnDeviceTailModelExecutor::ModelInput input(kTestPrefix, "", 5);
std::vector<OnDeviceTailModelExecutor::Prediction> predictions =
executor->GenerateSuggestionsForPrefix(input);
LOCAL_HISTOGRAM_BOOLEAN("Omnibox.OnDeviceTailModel.HasResultForTestPrefix",
!predictions.empty());
}
}
std::vector<OnDeviceTailModelExecutor::Prediction> RunTailModelExecutor(
OnDeviceTailModelExecutor* executor,
const OnDeviceTailModelExecutor::ModelInput& input) {
std::vector<OnDeviceTailModelExecutor::Prediction> predictions;
if (executor == nullptr) {
return predictions;
}
if (!executor->IsReady() && !executor->Init()) {
return predictions;
}
predictions = executor->GenerateSuggestionsForPrefix(input);
return predictions;
}
void MaybeUnloadModelExecutor(OnDeviceTailModelExecutor* executor) {
if (executor == nullptr || !executor->IsReady()) {
return;
}
executor->Reset();
}
} // namespace
OnDeviceTailModelService::OnDeviceTailModelService(
optimization_guide::OptimizationGuideModelProvider* model_provider)
: model_executor_task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::BEST_EFFORT})),
tail_model_executor_(
new OnDeviceTailModelExecutor(),
base::OnTaskRunnerDeleter(model_executor_task_runner_)),
model_provider_(model_provider) {
if (model_provider_ == nullptr) {
return;
}
model_provider_->AddObserverForOptimizationTargetModel(
optimization_guide::proto::
OPTIMIZATION_TARGET_OMNIBOX_ON_DEVICE_TAIL_SUGGEST,
/* model_metadata= */ std::nullopt, this);
memory_pressure_listener_ = std::make_unique<base::MemoryPressureListener>(
FROM_HERE,
base::BindRepeating(&OnDeviceTailModelService::OnMemoryPressure,
weak_ptr_factory_.GetWeakPtr()));
}
OnDeviceTailModelService::OnDeviceTailModelService()
: tail_model_executor_(nullptr, base::OnTaskRunnerDeleter(nullptr)) {}
OnDeviceTailModelService::~OnDeviceTailModelService() {
if (model_provider_) {
model_provider_->RemoveObserverForOptimizationTargetModel(
optimization_guide::proto::
OPTIMIZATION_TARGET_OMNIBOX_ON_DEVICE_TAIL_SUGGEST,
this);
model_provider_ = nullptr;
}
}
void OnDeviceTailModelService::Shutdown() {
if (memory_pressure_listener_) {
memory_pressure_listener_.reset();
}
weak_ptr_factory_.InvalidateWeakPtrs();
}
void OnDeviceTailModelService::OnModelUpdated(
optimization_guide::proto::OptimizationTarget optimization_target,
base::optional_ref<const optimization_guide::ModelInfo> model_info) {
if (optimization_target !=
optimization_guide::proto::
OPTIMIZATION_TARGET_OMNIBOX_ON_DEVICE_TAIL_SUGGEST) {
return;
}
if (!model_info.has_value()) {
model_executor_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&OnDeviceTailModelExecutor::Reset,
base::Unretained(tail_model_executor_.get())));
return;
}
const std::optional<optimization_guide::proto::Any>& metadata =
model_info->GetModelMetadata();
std::optional<optimization_guide::proto::OnDeviceTailSuggestModelMetadata>
tail_model_metadata = std::nullopt;
if (metadata.has_value()) {
tail_model_metadata = optimization_guide::ParsedAnyMetadata<
optimization_guide::proto::OnDeviceTailSuggestModelMetadata>(
metadata.value());
}
if (!tail_model_metadata.has_value()) {
DVLOG(1) << "Failed to fetch metadata for Omnibox on device tail model";
return;
}
model_executor_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&InitializeTailModelExecutor, tail_model_executor_.get(),
model_info->GetModelFilePath(),
model_info->GetAdditionalFiles(),
tail_model_metadata.value()));
}
void OnDeviceTailModelService::OnMemoryPressure(
base::MemoryPressureListener::MemoryPressureLevel level) {
if (level != base::MemoryPressureListener::MEMORY_PRESSURE_LEVEL_CRITICAL) {
return;
}
if (model_executor_task_runner_) {
model_executor_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&MaybeUnloadModelExecutor, tail_model_executor_.get()));
}
}
void OnDeviceTailModelService::GetPredictionsForInput(
const OnDeviceTailModelExecutor::ModelInput& input,
ResultCallback result_callback) {
if (model_executor_task_runner_) {
base::MemoryPressureMonitor* monitor = base::MemoryPressureMonitor::Get();
// Do not call the model if memory pressure level is too high.
if (!monitor ||
monitor->GetCurrentPressureLevel() !=
base::MemoryPressureListener::MEMORY_PRESSURE_LEVEL_CRITICAL) {
model_executor_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&RunTailModelExecutor, tail_model_executor_.get(),
input),
std::move(result_callback));
return;
}
}
std::move(result_callback)
.Run(std::vector<OnDeviceTailModelExecutor::Prediction>());
}
|
