Interface ProfilerOptions.ProfileOptionsOrBuilder

All Superinterfaces:
MessageLiteOrBuilder, MessageOrBuilder
All Known Implementing Classes:
ProfilerOptions.ProfileOptions, ProfilerOptions.ProfileOptions.Builder
Enclosing class:
ProfilerOptions
public static interface ProfilerOptions.ProfileOptionsOrBuilder extends MessageOrBuilder

  • Method Details

    • getVersion

      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;
      Returns:
      The version.

    • getDeviceTypeValue

      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.
DeviceType::PLUGGABLE_DEVICE: only CPU/pluggable devices with profilers
will be profiled.
      .tensorflow.ProfileOptions.DeviceType device_type = 6;
      Returns:
      The enum numeric value on the wire for deviceType.

    • getDeviceType

      ProfilerOptions.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.
DeviceType::PLUGGABLE_DEVICE: only CPU/pluggable devices with profilers
will be profiled.
      .tensorflow.ProfileOptions.DeviceType device_type = 6;
      Returns:
      The deviceType.

    • getIncludeDatasetOps

      boolean getIncludeDatasetOps()
      We don't collect the dataset ops by default for better trace-viewer
scalability. The caller can manually set this field to include the ops.
      bool include_dataset_ops = 1;
      Returns:
      The includeDatasetOps.

    • getHostTracerLevel

      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,
this is the default.
- Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high
level program execution details (expensive TF ops, XLA ops, etc).
- 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;
      Returns:
      The hostTracerLevel.

    • getDeviceTracerLevel

      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;
      Returns:
      The deviceTracerLevel.

    • getPythonTracerLevel

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

    • getEnableHloProto

      boolean getEnableHloProto()
      Whether serialize hlo_proto when XLA is used. (version >= 1)
      bool enable_hlo_proto = 7;
      Returns:
      The enableHloProto.

    • getStartTimestampNs

      long getStartTimestampNs()
      The local profiler starts profiling at this Unix timestamp in nanoseconds.
      uint64 start_timestamp_ns = 8;
      Returns:
      The startTimestampNs.

    • getDurationMs

      long getDurationMs()
      The local profiler collects `duration_ms` milliseconds of data. If the
value is 0, profiling continues until interrupted.
      uint64 duration_ms = 9;
      Returns:
      The durationMs.

    • getRepositoryPath

      String getRepositoryPath()
      Directory to save profile data to. No-op when empty.
      string repository_path = 10;
      Returns:
      The repositoryPath.

    • getRepositoryPathBytes

      ByteString getRepositoryPathBytes()
      Directory to save profile data to. No-op when empty.
      string repository_path = 10;
      Returns:
      The bytes for repositoryPath.

    • hasTraceOptions

      boolean hasTraceOptions()
      .tensorflow.ProfileOptions.TraceOptions trace_options = 11;
      Returns:
      Whether the traceOptions field is set.

    • getTraceOptions

      ProfilerOptions.ProfileOptions.TraceOptions getTraceOptions()
      .tensorflow.ProfileOptions.TraceOptions trace_options = 11;
      Returns:
      The traceOptions.

    • getTraceOptionsOrBuilder

      ProfilerOptions.ProfileOptions.TraceOptionsOrBuilder getTraceOptionsOrBuilder()
      .tensorflow.ProfileOptions.TraceOptions trace_options = 11;

    • getAdvancedConfigurationCount

      int getAdvancedConfigurationCount()
      Advanced configuration for the profiler contains a map of config name to
config value. It gives the flexibility to pass any configuration to the
profiler. eg:
advanced_configuration {
key: "tpu_trace_mode"
value: {
int64_value: 2
}
}
      map<string, .tensorflow.ProfileOptions.AdvancedConfigValue> advanced_configuration = 12;

    • containsAdvancedConfiguration

      boolean containsAdvancedConfiguration(String key)
      Advanced configuration for the profiler contains a map of config name to
config value. It gives the flexibility to pass any configuration to the
profiler. eg:
advanced_configuration {
key: "tpu_trace_mode"
value: {
int64_value: 2
}
}
      map<string, .tensorflow.ProfileOptions.AdvancedConfigValue> advanced_configuration = 12;

    • getAdvancedConfiguration

      @Deprecated Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> getAdvancedConfiguration()
      Deprecated.
      Use getAdvancedConfigurationMap() instead.

    • getAdvancedConfigurationMap

      Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> getAdvancedConfigurationMap()
      Advanced configuration for the profiler contains a map of config name to
config value. It gives the flexibility to pass any configuration to the
profiler. eg:
advanced_configuration {
key: "tpu_trace_mode"
value: {
int64_value: 2
}
}
      map<string, .tensorflow.ProfileOptions.AdvancedConfigValue> advanced_configuration = 12;

    • getAdvancedConfigurationOrDefault

      ProfilerOptions.ProfileOptions.AdvancedConfigValue getAdvancedConfigurationOrDefault(String key, ProfilerOptions.ProfileOptions.AdvancedConfigValue defaultValue)
      Advanced configuration for the profiler contains a map of config name to
config value. It gives the flexibility to pass any configuration to the
profiler. eg:
advanced_configuration {
key: "tpu_trace_mode"
value: {
int64_value: 2
}
}
      map<string, .tensorflow.ProfileOptions.AdvancedConfigValue> advanced_configuration = 12;

    • getAdvancedConfigurationOrThrow

      ProfilerOptions.ProfileOptions.AdvancedConfigValue getAdvancedConfigurationOrThrow(String key)
      Advanced configuration for the profiler contains a map of config name to
config value. It gives the flexibility to pass any configuration to the
profiler. eg:
advanced_configuration {
key: "tpu_trace_mode"
value: {
int64_value: 2
}
}
      map<string, .tensorflow.ProfileOptions.AdvancedConfigValue> advanced_configuration = 12;

    • getRaiseErrorOnStartFailure

      boolean getRaiseErrorOnStartFailure()
      bool raise_error_on_start_failure = 13;
      Returns:
      The raiseErrorOnStartFailure.

    • getSessionId

      String getSessionId()
      Identifier of the profiling session. This will be used as the subdirectory
under the repository path. If not set, the current timestamp will be used.
      string session_id = 14;
      Returns:
      The sessionId.

    • getSessionIdBytes

      ByteString getSessionIdBytes()
      Identifier of the profiling session. This will be used as the subdirectory
under the repository path. If not set, the current timestamp will be used.
      string session_id = 14;
      Returns:
      The bytes for sessionId.

    • getOverrideHostname

      String getOverrideHostname()
      If set, this hostname will be used to name the profile file.
      string override_hostname = 15;
      Returns:
      The overrideHostname.

    • getOverrideHostnameBytes

      ByteString getOverrideHostnameBytes()
      If set, this hostname will be used to name the profile file.
      string override_hostname = 15;
      Returns:
      The bytes for overrideHostname.