1 /* Copyright 2017 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_RPC_CLIENT_DUMP_TPU_PROFILE_H_ 17 #define TENSORFLOW_CORE_PROFILER_RPC_CLIENT_DUMP_TPU_PROFILE_H_ 18 19 #include "tensorflow/core/lib/core/status.h" 20 #include "tensorflow/core/platform/grpc_services.h" 21 22 namespace tensorflow { 23 24 namespace profiler { 25 namespace client { 26 27 // Dumps all profiling tool data in a TPU profile to a TensorBoard log directory 28 // with the given run name. This writes user-facing log messages to `os`. 29 // The following tools are supported: 30 // - Trace viewer 31 // - Op profile 32 // - Input pipeline analyzer 33 // - Overview page 34 // Note: this function creates a directory even when all fields in 35 // ProfileResponse are unset/empty. 36 Status WriteTensorboardTPUProfile(const string& logdir, const string& run, 37 const string& host, 38 const ProfileResponse& response, 39 std::ostream* os); 40 41 } // namespace client 42 } // namespace profiler 43 } // namespace tensorflow 44 45 #endif // TENSORFLOW_CORE_PROFILER_RPC_CLIENT_DUMP_TPU_PROFILE_H_ 46