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
|
// 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/search_user_model.h"
#include <array>
#include "base/feature_list.h"
#include "base/metrics/field_trial_params.h"
#include "base/task/sequenced_task_runner.h"
#include "components/segmentation_platform/internal/database/ukm_types.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 "services/metrics/public/cpp/ukm_builders.h"
namespace segmentation_platform {
namespace {
using proto::SegmentId;
// Default parameters for search user model.
constexpr uint64_t kSearchUserModelVersion = 2;
constexpr SegmentId kSearchUserSegmentId =
SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_SEARCH_USER;
constexpr int64_t kSearchUserSignalStorageLength = 28;
constexpr int64_t kSearchUserMinSignalCollectionLength = 7;
// Reference to the UMA ClientSummarizedResultType enum for Search.
constexpr std::array<int32_t, 1> kOnlySearch{1};
// InputFeatures.
constexpr std::array<MetadataWriter::UMAFeature, 1> kSearchUserUMAFeatures = {
MetadataWriter::UMAFeature::FromEnumHistogram(
"Omnibox.SuggestionUsed.ClientSummarizedResultType",
28,
kOnlySearch.data(),
kOnlySearch.size()),
};
#if BUILDFLAG(IS_IOS)
constexpr UkmEventHash kPageLoadHash = UkmEventHash::FromUnsafeValue(
ukm::builders::MainFrameNavigation::kEntryNameHash);
constexpr UkmMetricHash kNavMetricHash = UkmMetricHash::FromUnsafeValue(
ukm::builders::MainFrameNavigation::kDidCommitNameHash);
#elif !BUILDFLAG(IS_CHROMEOS)
constexpr UkmEventHash kPageLoadHash =
UkmEventHash::FromUnsafeValue(ukm::builders::PageLoad::kEntryNameHash);
constexpr UkmMetricHash kNavMetricHash = UkmMetricHash::FromUnsafeValue(
ukm::builders::PageLoad::kPaintTiming_NavigationToFirstPaintNameHash);
#endif
std::unique_ptr<DefaultModelProvider> GetSearchUserDefaultModel() {
if (!base::GetFieldTrialParamByFeatureAsBool(
features::kSegmentationPlatformSearchUser, kDefaultModelEnabledParam,
true)) {
return nullptr;
}
return std::make_unique<SearchUserModel>();
}
} // namespace
// static
std::unique_ptr<Config> SearchUserModel::GetConfig() {
if (!base::FeatureList::IsEnabled(
features::kSegmentationPlatformSearchUser)) {
return nullptr;
}
auto config = std::make_unique<Config>();
config->segmentation_key = kSearchUserKey;
config->segmentation_uma_name = kSearchUserUmaName;
config->AddSegmentId(kSearchUserSegmentId, GetSearchUserDefaultModel());
config->auto_execute_and_cache = true;
return config;
}
SearchUserModel::SearchUserModel()
: DefaultModelProvider(kSearchUserSegmentId) {}
std::unique_ptr<DefaultModelProvider::ModelConfig>
SearchUserModel::GetModelConfig() {
proto::SegmentationModelMetadata search_user_metadata;
MetadataWriter writer(&search_user_metadata);
writer.SetDefaultSegmentationMetadataConfig(
kSearchUserMinSignalCollectionLength, kSearchUserSignalStorageLength);
search_user_metadata.set_upload_tensors(true);
// Set features.
writer.AddUmaFeatures(kSearchUserUMAFeatures.data(),
kSearchUserUMAFeatures.size());
// Segmentation Ukm Engine is disabled on CrOS.
#if !BUILDFLAG(IS_CHROMEOS)
std::string query =
"SELECT COUNT(id) FROM metrics WHERE metric_hash = '64BD7CCE5A95BF00'";
const std::array<UkmMetricHash, 1> kNavigationMetric = {kNavMetricHash};
const std::array<MetadataWriter::SqlFeature::EventAndMetrics, 1>
kPageLoadEvent{MetadataWriter::SqlFeature::EventAndMetrics{
.event_hash = kPageLoadHash,
.metrics = kNavigationMetric.data(),
.metrics_size = kNavigationMetric.size()}};
MetadataWriter::SqlFeature sql_feature{.sql = query.c_str(),
.events = kPageLoadEvent.data(),
.events_size = kPageLoadEvent.size()};
writer.AddSqlFeature(sql_feature);
#endif //! BUILDFLAG(IS_CHROMEOS)
// Set OutputConfig.
writer.AddOutputConfigForBinnedClassifier(
/*bins=*/{{1, kSearchUserModelLabelLow},
{5, kSearchUserModelLabelMedium},
{22, kSearchUserModelLabelHigh}},
/*underflow_label=*/kSearchUserModelLabelNone);
writer.AddPredictedResultTTLInOutputConfig(
/*top_label_to_ttl_list=*/{}, /*default_ttl=*/7,
/*time_unit=*/proto::TimeUnit::DAY);
return std::make_unique<ModelConfig>(std::move(search_user_metadata),
kSearchUserModelVersion);
}
void SearchUserModel::ExecuteModelWithInput(
const ModelProvider::Request& inputs,
ExecutionCallback callback) {
// Invalid inputs.
if (inputs.size() < kSearchUserUMAFeatures.size()) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback), std::nullopt));
return;
}
auto search_count = inputs[0];
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback),
ModelProvider::Response(1, search_count)));
}
} // namespace segmentation_platform
|