xref: /aosp_15_r20/external/tensorflow/tensorflow/core/profiler/utils/diagnostics.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2020 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_CORE_PROFILER_UTILS_ERRORS_H_
17 #define TENSORFLOW_CORE_PROFILER_UTILS_ERRORS_H_
18 
19 #include "absl/strings/string_view.h"
20 #include "tensorflow/core/platform/macros.h"
21 #include "tensorflow/core/profiler/protobuf/diagnostics.pb.h"
22 #include "tensorflow/core/profiler/protobuf/op_stats.pb.h"
23 
24 namespace tensorflow {
25 namespace profiler {
26 
27 // Error message that the visualization is based on incomplete step.
28 TF_CONST_INIT extern const absl::string_view kErrorIncompleteStep;
29 
30 // Error message that no step marker is seen and visualization contains no
31 // step info.
32 TF_CONST_INIT extern const absl::string_view kErrorNoStepMarker;
33 
34 TF_CONST_INIT extern const absl::string_view kNoDeviceTraceCollected;
35 
36 TF_CONST_INIT extern const absl::string_view kStepsDropped;
37 
38 void PopulateStepDiagnostics(const OpStats& op_stats, Diagnostics* diag);
39 
40 void PopulateOverviewDiagnostics(const OpStats& op_stats, Diagnostics* diag);
41 
42 }  // namespace profiler
43 }  // namespace tensorflow
44 
45 #endif  // TENSORFLOW_CORE_PROFILER_UTILS_ERRORS_H_
46