summaryrefslogtreecommitdiff
path: root/chromium/components/segmentation_platform/internal/scheduler/model_execution_scheduler_impl.h
blob: 36898affca7488e0231bebfd8f16efaf1b581309 (plain)
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
// Copyright 2021 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SEGMENTATION_PLATFORM_INTERNAL_SCHEDULER_MODEL_EXECUTION_SCHEDULER_IMPL_H_
#define COMPONENTS_SEGMENTATION_PLATFORM_INTERNAL_SCHEDULER_MODEL_EXECUTION_SCHEDULER_IMPL_H_

#include "base/memory/raw_ptr.h"
#include "components/segmentation_platform/internal/scheduler/model_execution_scheduler.h"

#include "base/cancelable_callback.h"
#include "base/containers/flat_set.h"
#include "base/memory/weak_ptr.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "components/segmentation_platform/internal/execution/model_execution_manager.h"
#include "components/segmentation_platform/internal/execution/model_execution_status.h"
#include "components/segmentation_platform/internal/platform_options.h"

namespace base {
class Clock;
}  // namespace base

namespace segmentation_platform {

namespace proto {
class SegmentInfo;
}  // namespace proto

class SegmentInfoDatabase;
class SignalStorageConfig;

class ModelExecutionSchedulerImpl : public ModelExecutionScheduler {
 public:
  ModelExecutionSchedulerImpl(
      std::vector<Observer*>&& observers,
      SegmentInfoDatabase* segment_database,
      SignalStorageConfig* signal_storage_config,
      ModelExecutionManager* model_execution_manager,
      base::flat_set<optimization_guide::proto::OptimizationTarget> segment_ids,
      base::Clock* clock,
      const PlatformOptions& platform_options);
  ~ModelExecutionSchedulerImpl() override;

  // Disallow copy/assign.
  ModelExecutionSchedulerImpl(const ModelExecutionSchedulerImpl&) = delete;
  ModelExecutionSchedulerImpl& operator=(const ModelExecutionSchedulerImpl&) =
      delete;

  // ModelExecutionScheduler overrides.
  void OnNewModelInfoReady(const proto::SegmentInfo& segment_info) override;
  void RequestModelExecutionForEligibleSegments(bool expired_only) override;
  void RequestModelExecution(OptimizationTarget segment_id) override;
  void OnModelExecutionCompleted(
      OptimizationTarget segment_id,
      const std::pair<float, ModelExecutionStatus>& score) override;

 private:
  void FilterEligibleSegments(
      bool expired_only,
      std::vector<std::pair<OptimizationTarget, proto::SegmentInfo>>
          all_segments);
  bool ShouldExecuteSegment(bool expired_only,
                            const proto::SegmentInfo& segment_info);
  void CancelOutstandingExecutionRequests(OptimizationTarget segment_id);

  void OnResultSaved(OptimizationTarget segment_id, bool success);

  // Observers listening to model exeuction events. Required by the segment
  // selection pipeline.
  std::vector<Observer*> observers_;

  // The database storing metadata and results.
  raw_ptr<SegmentInfoDatabase> segment_database_;

  // Used for confirming if the signals have been collected long enough.
  raw_ptr<SignalStorageConfig> signal_storage_config_;

  // The class that executes the models.
  raw_ptr<ModelExecutionManager> model_execution_manager_;

  // The set of all known segments.
  base::flat_set<optimization_guide::proto::OptimizationTarget>
      all_segment_ids_;

  // The time provider.
  raw_ptr<base::Clock> clock_;

  const PlatformOptions platform_options_;

  // In-flight model execution requests. Will be killed if we get a model
  // update.
  std::map<OptimizationTarget,
           base::CancelableOnceCallback<
               ModelExecutionManager::ModelExecutionCallback::RunType>>
      outstanding_requests_;

  base::WeakPtrFactory<ModelExecutionSchedulerImpl> weak_ptr_factory_{this};
};

}  // namespace segmentation_platform

#endif  // COMPONENTS_SEGMENTATION_PLATFORM_INTERNAL_SCHEDULER_MODEL_EXECUTION_SCHEDULER_IMPL_H_