1/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
2
3Licensed under the Apache License, Version 2.0 (the "License");
4you may not use this file except in compliance with the License.
5You may obtain a copy of the License at
6
7 http://www.apache.org/licenses/LICENSE-2.0
8
9Unless required by applicable law or agreed to in writing, software
10distributed under the License is distributed on an "AS IS" BASIS,
11WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12See the License for the specific language governing permissions and
13limitations under the License.
14==============================================================================*/
15
16#ifndef TENSORFLOW_CORE_COMMON_RUNTIME_COST_MEASUREMENT_H_
17#define TENSORFLOW_CORE_COMMON_RUNTIME_COST_MEASUREMENT_H_
18
19#include "absl/strings/string_view.h"
20#include "absl/time/time.h"
21
22namespace tensorflow {
23
24// An interface for cost measurement.
25class CostMeasurement {
26 public:
27 // Context of the CostMeasurement.
28 struct Context {
29 // Whether this CostMeasurement is running within a per-query context (e.g.
30 // rpc handler) or not (e.g. batching).
31 bool is_per_query = false;
32 };
33
34 explicit CostMeasurement(const Context& context) {}
35
36 virtual ~CostMeasurement() {}
37
38 virtual absl::Duration GetTotalCost() = 0;
39
40 virtual absl::string_view GetCostType() const = 0;
41};
42
43} // namespace tensorflow
44
45#endif // TENSORFLOW_CORE_COMMON_RUNTIME_COST_MEASUREMENT_H_
46