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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
// Copyright 2021 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/optimization_guide/core/delivery/model_util.h"
#include "base/base64.h"
#include "base/containers/flat_set.h"
#include "base/files/file_util.h"
#include "base/hash/legacy_hash.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "components/optimization_guide/core/optimization_guide_switches.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "net/base/url_util.h"
#include "url/url_canon.h"
namespace optimization_guide {
// These names are persisted to histograms, so don't change them.
std::string GetStringNameForOptimizationTarget(
optimization_guide::proto::OptimizationTarget optimization_target) {
switch (optimization_target) {
case proto::OPTIMIZATION_TARGET_UNKNOWN:
return "Unknown";
case proto::OPTIMIZATION_TARGET_PAINFUL_PAGE_LOAD:
return "PainfulPageLoad";
case proto::OPTIMIZATION_TARGET_LANGUAGE_DETECTION:
return "LanguageDetection";
case proto::OPTIMIZATION_TARGET_PAGE_TOPICS:
return "PageTopics";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_NEW_TAB:
return "SegmentationNewTab";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_SHARE:
return "SegmentationShare";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_VOICE:
return "SegmentationVoice";
case proto::OPTIMIZATION_TARGET_MODEL_VALIDATION:
return "ModelValidation";
case proto::OPTIMIZATION_TARGET_PAGE_ENTITIES:
return "PageEntities";
case proto::OPTIMIZATION_TARGET_NOTIFICATION_PERMISSION_PREDICTIONS:
return "NotificationPermissions";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_DUMMY:
return "SegmentationDummyFeature";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_CHROME_START_ANDROID:
return "SegmentationChromeStartAndroid";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_QUERY_TILES:
return "SegmentationQueryTiles";
case proto::OPTIMIZATION_TARGET_PAGE_VISIBILITY:
return "PageVisibility";
case proto::OPTIMIZATION_TARGET_PAGE_TOPICS_V2:
return "PageTopicsV2";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_CHROME_LOW_USER_ENGAGEMENT:
return "SegmentationChromeLowUserEngagement";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_FEED_USER:
return "SegmentationFeedUser";
case proto::OPTIMIZATION_TARGET_CONTEXTUAL_PAGE_ACTION_PRICE_TRACKING:
return "ContextualPageActionPriceTracking";
case proto::OPTIMIZATION_TARGET_TEXT_CLASSIFIER:
return "TextClassifier";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_SHOPPING_USER:
return "SegmentationShoppingUser";
case proto::OPTIMIZATION_TARGET_GEOLOCATION_PERMISSION_PREDICTIONS:
return "GeolocationPermissions";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_CHROME_START_ANDROID_V2:
return "SegmentationChromeStartAndroidV2";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_SEARCH_USER:
return "SegmentationSearchUser";
case proto::OPTIMIZATION_TARGET_OMNIBOX_ON_DEVICE_TAIL_SUGGEST:
return "OmniboxOnDeviceTailSuggest";
case proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING:
return "ClientSidePhishing";
case proto::OPTIMIZATION_TARGET_OMNIBOX_URL_SCORING:
return "OmniboxUrlScoring";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_DEVICE_SWITCHER:
return "SegmentationDeviceSwitcher";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_ADAPTIVE_TOOLBAR:
return "SegmentationAdaptiveToolbar";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_TABLET_PRODUCTIVITY_USER:
return "SegmentationTabletProductivityUser";
case proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER:
return "ClientSidePhishingImageEmbedder";
case proto::
OPTIMIZATION_TARGET_NEW_TAB_PAGE_HISTORY_CLUSTERS_MODULE_RANKING:
return "NewTabPageHistoryClustersModuleRanking";
case proto::OPTIMIZATION_TARGET_WEB_APP_INSTALLATION_PROMO:
return "WebAppInstallationPromo";
case proto::OPTIMIZATION_TARGET_TEXT_EMBEDDER:
return "TextEmbedder";
case proto::OPTIMIZATION_TARGET_VISUAL_SEARCH_CLASSIFICATION:
return "VisualSearchClassification";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_BOTTOM_TOOLBAR:
return "SegmentationBottomToolbar";
case proto::OPTIMIZATION_TARGET_AUTOFILL_FIELD_CLASSIFICATION:
return "AutofillFieldTypeClassification";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_IOS_MODULE_RANKER:
return "SegmentationIosModuleRanker";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_DESKTOP_NTP_MODULE:
return "SegmentationDesktopNtpModule";
case proto::OPTIMIZATION_TARGET_PRELOADING_HEURISTICS:
return "PreloadingHeuristics";
case proto::OPTIMIZATION_TARGET_TEXT_SAFETY:
return "TextSafety";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_ANDROID_HOME_MODULE_RANKER:
return "SegmentationAndroidHomeModuleRanker";
case proto::OPTIMIZATION_TARGET_COMPOSE:
return "Compose";
case proto::OPTIMIZATION_TARGET_PASSAGE_EMBEDDER:
return "PassageEmbedder";
case proto::OPTIMIZATION_TARGET_PHRASE_SEGMENTATION:
return "PhraseSegmentation";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_COMPOSE_PROMOTION:
return "SegmentationComposePromotion";
case proto::OPTIMIZATION_TARGET_URL_VISIT_RESUMPTION_RANKER:
return "URLVisitResumptionRanker";
case proto::OPTIMIZATION_TARGET_CAMERA_BACKGROUND_SEGMENTATION:
return "CameraBackgroundSegmentation";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_HISTORY_SEARCH:
return "ModelExecutionFeatureHistorySearch";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_PROMPT_API:
return "ModelExecutionFeaturePromptAPI";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_METRICS_CLUSTERING:
return "SegmentationMetricsClustering";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_SUMMARIZE:
return "ModelExecutionFeatureSummarize";
case proto::OPTIMIZATION_TARGET_PASSWORD_MANAGER_FORM_CLASSIFICATION:
return "PasswordManagerFormClassification";
case proto::OPTIMIZATION_TARGET_NOTIFICATION_CONTENT_DETECTION:
return "NotificationContentDetection";
case proto::
OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_HISTORY_QUERY_INTENT:
return "ModelExecutionFeatureHistoryQueryIntent";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_SCAM_DETECTION:
return "ModelExecutionFeatureScamDetection";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_PERMISSIONS_AI:
return "ModelExecutionFeaturePermissionsAi";
case proto::
OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_WRITING_ASSISTANCE_API:
return "ModelExecutionFeatureWritingAssistanceApi";
case proto::OPTIMIZATION_TARGET_EXPERIMENTAL_EMBEDDER:
return "ExperimentalEmbedder";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_FEDCM_USER:
return "SegmentationFedCmUser";
case proto::OPTIMIZATION_TARGET_GEOLOCATION_IMAGE_PERMISSION_RELEVANCE:
return "GeolocationPermissionsV3";
case proto::OPTIMIZATION_TARGET_NOTIFICATION_IMAGE_PERMISSION_RELEVANCE:
return "NotificationPermissionsV3";
case proto::OPTIMIZATION_TARGET_MODEL_EXECUTION_FEATURE_PROOFREADER_API:
return "ModelExecutionFeatureProofreaderApi";
case proto::OPTIMIZATION_TARGET_SEGMENTATION_IOS_DEFAULT_BROWSER_PROMO:
return "SegmentationIosDefaultBrowserPromo";
// Whenever a new value is added, make sure to add it to the OptTarget
// variant list in
// //tools/metrics/histograms/metadata/optimization/histograms.xml.
}
NOTREACHED();
}
std::optional<base::FilePath> StringToFilePath(const std::string& str_path) {
if (str_path.empty()) {
return std::nullopt;
}
#if BUILDFLAG(IS_WIN)
return base::FilePath(base::UTF8ToWide(str_path));
#else
return base::FilePath(str_path);
#endif
}
std::string FilePathToString(const base::FilePath& file_path) {
#if BUILDFLAG(IS_WIN)
return base::WideToUTF8(file_path.value());
#else
return file_path.value();
#endif
}
base::FilePath GetBaseFileNameForModels() {
return base::FilePath(FILE_PATH_LITERAL("model.tflite"));
}
base::FilePath GetBaseFileNameForModelInfo() {
return base::FilePath(FILE_PATH_LITERAL("model-info.pb"));
}
bool CheckAllPathsExist(
const std::vector<base::FilePath>& file_paths_to_check) {
for (const base::FilePath& file_path : file_paths_to_check) {
if (!base::PathExists(file_path)) {
return false;
}
}
return true;
}
base::FilePath ConvertToRelativePath(const base::FilePath& parent,
const base::FilePath& child) {
DCHECK(parent.IsAbsolute());
DCHECK(child.IsAbsolute());
DCHECK(parent.IsParent(child));
const auto parent_components = parent.GetComponents();
const auto child_components = child.GetComponents();
base::FilePath relative_path;
for (size_t i = parent_components.size(); i < child_components.size(); i++) {
relative_path = relative_path.Append(child_components[i]);
}
return relative_path;
}
std::string GetModelCacheKeyHash(proto::ModelCacheKey model_cache_key) {
std::string bytes;
model_cache_key.SerializeToString(&bytes);
uint64_t hash = base::legacy::CityHash64(base::as_byte_span(bytes));
// Convert the hash to hex encoding and not as base64 and other encodings,
// since it will be used as filepath names.
return base::HexEncode(base::byte_span_from_ref(hash));
}
void RecordPredictionModelStoreModelRemovalVersionHistogram(
proto::OptimizationTarget optimization_target,
PredictionModelStoreModelRemovalReason model_removal_reason) {
base::UmaHistogramEnumeration(
"OptimizationGuide.PredictionModelStore.ModelRemovalReason",
model_removal_reason);
base::UmaHistogramEnumeration(
"OptimizationGuide.PredictionModelStore.ModelRemovalReason." +
GetStringNameForOptimizationTarget(optimization_target),
model_removal_reason);
}
bool IsPredictionModelVersionInKillSwitch(
const std::map<proto::OptimizationTarget, std::set<int64_t>>&
killswitch_model_versions,
proto::OptimizationTarget opt_target,
int64_t model_version) {
auto killswitch_model_versions_it =
killswitch_model_versions.find(opt_target);
if (killswitch_model_versions_it == killswitch_model_versions.end()) {
return false;
}
return killswitch_model_versions_it->second.find(model_version) !=
killswitch_model_versions_it->second.end();
}
std::optional<proto::ModelInfo> ParseModelInfoFromFile(
const base::FilePath& model_info_path) {
std::string binary_model_info;
if (!base::ReadFileToString(model_info_path, &binary_model_info)) {
return std::nullopt;
}
proto::ModelInfo model_info;
if (!model_info.ParseFromString(binary_model_info)) {
return std::nullopt;
}
DCHECK(model_info.has_version());
DCHECK(model_info.has_optimization_target());
return model_info;
}
} // namespace optimization_guide
|
