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
|
// Copyright 2024 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/segmentation_platform/embedder/default_model/fedcm_user_segment.h"
#include <cstdint>
#include <memory>
#include "base/task/sequenced_task_runner.h"
#include "components/segmentation_platform/internal/metadata/metadata_writer.h"
#include "components/segmentation_platform/public/config.h"
#include "components/segmentation_platform/public/constants.h"
#include "components/segmentation_platform/public/features.h"
#include "components/segmentation_platform/public/proto/aggregation.pb.h"
#include "components/segmentation_platform/public/proto/model_metadata.pb.h"
namespace segmentation_platform {
namespace {
using proto::SegmentId;
// Default parameters for FedCM user model.
constexpr SegmentId kFedCmUserSegmentId =
SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_FEDCM_USER;
// Store 28 buckets of input data (28 days).
constexpr int64_t kFedCmUserSignalStorageLength = 28;
// Collect signals immediately.
constexpr int64_t kFedCmUserMinSignalCollectionLength = 0;
// Refresh the result every 7 days.
constexpr int64_t kFedCmUserResultTTLDays = 7;
// InputFeatures.
// Positive enum value for Blink.FedCm.Status.RequestIdToken.
constexpr std::array<int32_t, 2> kTokenResponsePositiveEnumValues{
0, // Success using token in HTTP response.
46, // Success using identity provider resolve.
};
// Negative enum values for Blink.FedCm.CancelReason.
constexpr std::array<int32_t, 2> kCancelReasonNegativeEnumValues{
2, // Close button.
3, // Swipe.
};
// Enum value for Blink.FedCm.IsSignInUser.
constexpr std::array<int32_t, 1> kIsSignInUserValue{
1, // True.
};
const char kFedCmUserLoudLabel[] = "FedCmUserLoud";
const char kFedCmUserQuietLabel[] = "FedCmUserQuiet";
// Set UMA metrics to use as input.
constexpr std::array<MetadataWriter::UMAFeature, 4> kFedCmUserUMAFeatures = {
// Number of times accounts dialog is shown.
MetadataWriter::UMAFeature::FromValueHistogram(
"Blink.FedCm.AccountsDialogShown",
28,
proto::Aggregation::COUNT),
// Number of successful token requests.
MetadataWriter::UMAFeature::FromEnumHistogram(
"Blink.FedCm.Status.RequestIdToken",
28,
kTokenResponsePositiveEnumValues.data(),
kTokenResponsePositiveEnumValues.size()),
// Number of times user has intentionally closed FedCM UI. (Close
// button/Swipe)
MetadataWriter::UMAFeature::FromEnumHistogram(
"Blink.FedCm.CancelReason",
28,
kCancelReasonNegativeEnumValues.data(),
kCancelReasonNegativeEnumValues.size()),
// Whether the user is signed in i.e. used FedCM previously.
MetadataWriter::UMAFeature::FromEnumHistogram("Blink.FedCm.IsSignInUser",
28,
kIsSignInUserValue.data(),
kIsSignInUserValue.size()),
};
} // namespace
// static
std::unique_ptr<Config> FedCmUserModel::GetConfig() {
if (!base::FeatureList::IsEnabled(features::kSegmentationPlatformFedCmUser)) {
return nullptr;
}
auto config = std::make_unique<Config>();
config->segmentation_key = kFedCmUserKey;
config->segmentation_uma_name = kFedCmUserUmaName;
config->AddSegmentId(kFedCmUserSegmentId, std::make_unique<FedCmUserModel>());
config->auto_execute_and_cache = false;
config->is_boolean_segment = true;
return config;
}
FedCmUserModel::FedCmUserModel() : DefaultModelProvider(kFedCmUserSegmentId) {}
std::unique_ptr<DefaultModelProvider::ModelConfig>
FedCmUserModel::GetModelConfig() {
proto::SegmentationModelMetadata intentional_user_metadata;
MetadataWriter writer(&intentional_user_metadata);
writer.SetDefaultSegmentationMetadataConfig(
kFedCmUserMinSignalCollectionLength, kFedCmUserSignalStorageLength);
// Set output config.
writer.AddOutputConfigForBinaryClassifier(
0.5,
/*positive_label=*/kFedCmUserLoudLabel,
/*negative_label=*/kFedCmUserQuietLabel);
writer.AddPredictedResultTTLInOutputConfig(
/*top_label_to_ttl_list=*/{},
/*default_ttl=*/kFedCmUserResultTTLDays, proto::TimeUnit::DAY);
// Set features.
writer.AddUmaFeatures(kFedCmUserUMAFeatures.data(),
kFedCmUserUMAFeatures.size());
return std::make_unique<ModelConfig>(std::move(intentional_user_metadata),
/*model_version=*/1);
}
void FedCmUserModel::ExecuteModelWithInput(const ModelProvider::Request& inputs,
ExecutionCallback callback) {
// Invalid inputs.
if (inputs.size() != kFedCmUserUMAFeatures.size()) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback), std::nullopt));
return;
}
float result = 0;
const int accounts_dialog_shown_count = inputs[0];
const int successful_token_requests_count = inputs[1];
const int intentional_ui_dismissed_count = inputs[2];
const int signed_in_user_count = inputs[3];
if (accounts_dialog_shown_count == 0 ||
successful_token_requests_count >= 1 ||
intentional_ui_dismissed_count <= 2 || signed_in_user_count >= 1) {
result = 1;
}
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(std::move(callback), ModelProvider::Response(1, result)));
}
} // namespace segmentation_platform
|
