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_CONVERT_XPLANE_TO_MEMORY_PROFILE_H_
17 #define TENSORFLOW_CORE_PROFILER_CONVERT_XPLANE_TO_MEMORY_PROFILE_H_
18 
19 #include "tensorflow/core/platform/status.h"
20 #include "tensorflow/core/platform/types.h"
21 #include "tensorflow/core/profiler/protobuf/memory_profile.pb.h"
22 #include "tensorflow/core/profiler/protobuf/xplane.pb.h"
23 
24 namespace tensorflow {
25 namespace profiler {
26 
27 // Process the host threads XPlane and generate MemoryProfile result; at most
28 // max_num_snapshots will be displayed on the UI.
29 // REQUIRED: host_plane should have been grouped by calling GroupTfEvents().
30 MemoryProfile ConvertXPlaneToMemoryProfile(const XPlane& host_plane,
31                                            int64 max_num_snapshots = 1000);
32 
33 Status ConvertXSpaceToMemoryProfileJson(const XSpace& xspace,
34                                         std::string* json_output);
35 }  // namespace profiler
36 }  // namespace tensorflow
37 
38 #endif  // TENSORFLOW_CORE_PROFILER_CONVERT_XPLANE_TO_MEMORY_PROFILE_H_
39