1/* Copyright 2019 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#ifndef TENSORFLOW_CORE_DATA_STATS_UTILS_H_
16#define TENSORFLOW_CORE_DATA_STATS_UTILS_H_
17
18#include "tensorflow/core/platform/types.h"
19
20namespace tensorflow {
21namespace data {
22namespace stats_utils {
23extern const char kDelimiter[];
24extern const char kExecutionTime[];
25extern const char kThreadUtilization[];
26extern const char kBufferSize[];
27extern const char kBufferCapacity[];
28extern const char kBufferUtilization[];
29extern const char kFilteredElements[];
30extern const char kDroppedElements[];
31extern const char kFeaturesCount[];
32extern const char kFeatureValuesCount[];
33extern const char kExamplesCount[];
34
35// Name for tf.data function execution time (in ns) histogram metrics.
36string ExecutionTimeHistogramName(const string& prefix);
37
38// Name for thread utilization (ratio of threads being used and maximum number
39// of threads allocated) scalar metrics.
40string ThreadUtilizationScalarName(const string& prefix);
41
42// Name for buffer size scalar metrics.
43string BufferSizeScalarName(const string& prefix);
44
45// Name for buffer capacity (maximum allocated buffer size) scalar metrics.
46string BufferCapacityScalarName(const string& prefix);
47
48// Name for buffer utilization (ratio of buffer size and maximum allocated
49// buffer size.) histogram metrics.
50string BufferUtilizationHistogramName(const string& prefix);
51
52// Name for filtered elements scalar metrics.
53string FilterdElementsScalarName(const string& prefix);
54
55// Name for dropped elements scalar mereics.
56string DroppedElementsScalarName(const string& prefix);
57
58// Name for features count histogram metrics.
59string FeatureHistogramName(const string& prefix);
60
61// Name for feature-values count histogram metrics.
62string FeatureValueHistogramName(const string& prefix);
63
64} // namespace stats_utils
65} // namespace data
66} // namespace tensorflow
67
68#endif // TENSORFLOW_CORE_DATA_STATS_UTILS_H_
69