ProfileOptionsOrBuilder

public interface ProfileOptionsOrBuilder
Known Indirect Subclasses

Public Methods

abstract int
getDeviceTracerLevel ()
 Levels of device tracing: (version >= 1)
 - Level 0 is used to disable device traces.
abstract ProfileOptions.DeviceType
getDeviceType ()
 Device type to profile/trace: (version >= 1)
 DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
abstract int
getDeviceTypeValue ()
 Device type to profile/trace: (version >= 1)
 DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
abstract long
getDurationMs ()
 The local profiler collects `duration_ms` milliseconds of data.
abstract boolean
getEnableHloProto ()
 Whether serialize hlo_proto when XLA is used.
abstract int
getHostTracerLevel ()
 Levels of host tracing: (version >= 1)
 - Level 0 is used to disable host traces.
abstract boolean
getIncludeDatasetOps ()
 We don't collect the dataset ops by default for better trace-viewer
 scalability.
abstract int
getPythonTracerLevel ()
 Whether enable python function calls tracing.
abstract String
getRepositoryPath ()
 Directory to save profile data to.
abstract com.google.protobuf.ByteString
getRepositoryPathBytes ()
 Directory to save profile data to.
abstract long
getStartTimestampNs ()
 The local profiler starts profiling at this Unix timestamp in nanoseconds.
abstract int
getVersion ()
 Some default value of option are not proto3 default value.

Public Methods

public abstract int getDeviceTracerLevel ()

 Levels of device tracing: (version >= 1)
 - Level 0 is used to disable device traces.
 - Level 1 is used to enable device traces.
 - More levels might be defined for specific device for controlling the
   verbosity of the trace.
 
uint32 device_tracer_level = 3;

public abstract ProfileOptions.DeviceType getDeviceType ()

 Device type to profile/trace: (version >= 1)
 DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
 DeviceType::CPU: only CPU will be profiled.
 DeviceType::GPU: only CPU/GPU will be profiled.
 DeviceType::TPU: only CPU/TPU will be profiled.
 
.tensorflow.ProfileOptions.DeviceType device_type = 6;

public abstract int getDeviceTypeValue ()

 Device type to profile/trace: (version >= 1)
 DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
 DeviceType::CPU: only CPU will be profiled.
 DeviceType::GPU: only CPU/GPU will be profiled.
 DeviceType::TPU: only CPU/TPU will be profiled.
 
.tensorflow.ProfileOptions.DeviceType device_type = 6;

public abstract long getDurationMs ()

 The local profiler collects `duration_ms` milliseconds of data. If the
 value is 0, profiling continues until interrupted.
 
uint64 duration_ms = 9;

public abstract boolean getEnableHloProto ()

 Whether serialize hlo_proto when XLA is used. (version >= 1)
 
bool enable_hlo_proto = 7;

public abstract int getHostTracerLevel ()

 Levels of host tracing: (version >= 1)
 - Level 0 is used to disable host traces.
 - Level 1 enables tracing of only user instrumented (or default) TraceMe.
 - Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high
           level program execution details (expensive TF ops, XLA ops, etc).
           This is the default.
 - Level 3 enables tracing of all level 2 TraceMe(s) and more verbose
           (low-level) program execution details (cheap TF ops, etc).
 
uint32 host_tracer_level = 2;

public abstract boolean getIncludeDatasetOps ()

 We don't collect the dataset ops by default for better trace-viewer
 scalability. The caller can mannually set this field to include the ops.
 
bool include_dataset_ops = 1;

public abstract int getPythonTracerLevel ()

 Whether enable python function calls tracing. Runtime overhead ensues if
 enabled. Default off. (version >= 1)
 
uint32 python_tracer_level = 4;

public abstract String getRepositoryPath ()

 Directory to save profile data to. No-op when empty.
 
string repository_path = 10;

public abstract com.google.protobuf.ByteString getRepositoryPathBytes ()

 Directory to save profile data to. No-op when empty.
 
string repository_path = 10;

public abstract long getStartTimestampNs ()

 The local profiler starts profiling at this Unix timestamp in nanoseconds.
 
uint64 start_timestamp_ns = 8;

public abstract int getVersion ()

 Some default value of option are not proto3 default value. Use this version
 to determine if we should use default option value instead of proto3
 default value.
 
uint32 version = 5;