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
|
// Copyright 2022 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/cross_device_user_segment.h"
#include <array>
#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/model_provider.h"
#include "components/segmentation_platform/public/proto/model_metadata.pb.h"
#include "ui/base/device_form_factor.h"
namespace segmentation_platform {
namespace {
// List of sub-segments for cross device segment.
enum class CrossDeviceUserBin {
kUnknown = 0,
kNoCrossDeviceUsage = 1,
kCrossDeviceMobile = 2,
kCrossDeviceDesktop = 3,
kCrossDeviceTablet = 4,
kCrossDeviceMobileAndDesktop = 5,
kCrossDeviceMobileAndTablet = 6,
kCrossDeviceDesktopAndTablet = 7,
kCrossDeviceAllDeviceTypes = 8,
kCrossDeviceOther = 9,
kMaxValue = kCrossDeviceOther
};
#define RANK(x) static_cast<int>(x)
using proto::SegmentId;
// Default parameters for cross device model.
constexpr int kModelVersion = 2;
constexpr SegmentId kCrossDeviceUserSegmentId =
SegmentId::CROSS_DEVICE_USER_SEGMENT;
constexpr int64_t kCrossDeviceUserSignalStorageLength = 28;
constexpr int64_t kCrossDeviceUserMinSignalCollectionLength = 1;
constexpr int kCrossDeviceUserSegmentSelectionTTLDays = 7;
// InputFeatures.
constexpr std::array<float, 1> kCrossDeviceFeatureDefaultValue{0};
constexpr std::array<MetadataWriter::UMAFeature, 4>
kCrossDeviceUserUMAFeatures = {
MetadataWriter::UMAFeature::FromValueHistogram(
"Sync.DeviceCount2",
28,
proto::Aggregation::LATEST_OR_DEFAULT,
kCrossDeviceFeatureDefaultValue.size(),
kCrossDeviceFeatureDefaultValue.data()),
MetadataWriter::UMAFeature::FromValueHistogram(
"Sync.DeviceCount2.Phone",
28,
proto::Aggregation::LATEST_OR_DEFAULT,
kCrossDeviceFeatureDefaultValue.size(),
kCrossDeviceFeatureDefaultValue.data()),
MetadataWriter::UMAFeature::FromValueHistogram(
"Sync.DeviceCount2.Desktop",
28,
proto::Aggregation::LATEST_OR_DEFAULT,
kCrossDeviceFeatureDefaultValue.size(),
kCrossDeviceFeatureDefaultValue.data()),
MetadataWriter::UMAFeature::FromValueHistogram(
"Sync.DeviceCount2.Tablet",
28,
proto::Aggregation::LATEST_OR_DEFAULT,
kCrossDeviceFeatureDefaultValue.size(),
kCrossDeviceFeatureDefaultValue.data())};
} // namespace
// static
std::unique_ptr<Config> CrossDeviceUserSegment::GetConfig() {
if (!base::FeatureList::IsEnabled(
features::kSegmentationPlatformCrossDeviceUser)) {
return nullptr;
}
auto config = std::make_unique<Config>();
config->segmentation_key = kCrossDeviceUserKey;
config->segmentation_uma_name = kCrossDeviceUserUmaName;
config->AddSegmentId(SegmentId::CROSS_DEVICE_USER_SEGMENT,
std::make_unique<CrossDeviceUserSegment>());
config->auto_execute_and_cache = true;
return config;
}
CrossDeviceUserSegment::CrossDeviceUserSegment()
: DefaultModelProvider(kCrossDeviceUserSegmentId) {}
std::unique_ptr<DefaultModelProvider::ModelConfig>
CrossDeviceUserSegment::GetModelConfig() {
proto::SegmentationModelMetadata chrome_start_metadata;
MetadataWriter writer(&chrome_start_metadata);
writer.SetDefaultSegmentationMetadataConfig(
kCrossDeviceUserMinSignalCollectionLength,
kCrossDeviceUserSignalStorageLength);
// Set features.
writer.AddUmaFeatures(kCrossDeviceUserUMAFeatures.data(),
kCrossDeviceUserUMAFeatures.size());
// Set OutputConfig.
writer.AddOutputConfigForBinnedClassifier(
/*bins=*/{{1, kNoCrossDeviceUsage},
{2, kCrossDeviceMobile},
{3, kCrossDeviceDesktop},
{4, kCrossDeviceTablet},
{5, kCrossDeviceMobileAndDesktop},
{6, kCrossDeviceMobileAndTablet},
{7, kCrossDeviceDesktopAndTablet},
{8, kCrossDeviceAllDeviceTypes},
{9, kCrossDeviceOther}},
/*underflow_label=*/kNoCrossDeviceUsage);
writer.AddPredictedResultTTLInOutputConfig(
/*top_label_to_ttl_list=*/{}, kCrossDeviceUserSegmentSelectionTTLDays,
/*time_unit=*/proto::TimeUnit::DAY);
return std::make_unique<ModelConfig>(std::move(chrome_start_metadata),
kModelVersion);
}
void CrossDeviceUserSegment::ExecuteModelWithInput(
const ModelProvider::Request& inputs,
ExecutionCallback callback) {
// Invalid inputs.
if (inputs.size() != kCrossDeviceUserUMAFeatures.size()) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback), std::nullopt));
return;
}
CrossDeviceUserBin segment = CrossDeviceUserBin::kNoCrossDeviceUsage;
float phone_count = inputs[1];
float desktop_count = inputs[2];
float tablet_count = inputs[3];
// Check for current device type and subtract it from the device count
// calculation.
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_MAC) || \
BUILDFLAG(IS_WIN)
desktop_count -= 1;
#elif BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
if (ui::GetDeviceFormFactor() == ui::DEVICE_FORM_FACTOR_TABLET) {
tablet_count -= 1;
} else {
phone_count -= 1;
}
#endif
const bool multi_device_active = inputs[0] >= 2;
const bool phone_active = phone_count >= 1;
const bool desktop_active = desktop_count >= 1;
const bool tablet_active = tablet_count >= 1;
if (multi_device_active) {
if (phone_active && desktop_active && tablet_active) {
segment = CrossDeviceUserBin::kCrossDeviceAllDeviceTypes;
} else if (phone_active && desktop_active) {
segment = CrossDeviceUserBin::kCrossDeviceMobileAndDesktop;
} else if (phone_active && tablet_active) {
segment = CrossDeviceUserBin::kCrossDeviceMobileAndTablet;
} else if (desktop_active && tablet_active) {
segment = CrossDeviceUserBin::kCrossDeviceDesktopAndTablet;
} else if (phone_active) {
segment = CrossDeviceUserBin::kCrossDeviceMobile;
} else if (desktop_active) {
segment = CrossDeviceUserBin::kCrossDeviceDesktop;
} else if (tablet_active) {
segment = CrossDeviceUserBin::kCrossDeviceTablet;
} else {
segment = CrossDeviceUserBin::kCrossDeviceOther;
}
} else {
segment = segment = CrossDeviceUserBin::kNoCrossDeviceUsage;
}
float result = RANK(segment);
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(std::move(callback), ModelProvider::Response(1, result)));
}
} // namespace segmentation_platform
|