Class ProfilerOptions.ProfileOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

com.google.protobuf.GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

org.tensorflow.proto.ProfilerOptions.ProfileOptions.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable, ProfilerOptions.ProfileOptionsOrBuilder

Enclosing class:

ProfilerOptions.ProfileOptions

public static final class ProfilerOptions.ProfileOptions.Builder
extends GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>
implements ProfilerOptions.ProfileOptionsOrBuilder

Next ID: 16

Protobuf type tensorflow.ProfileOptions

Method Summary

Modifier and Type	Method	Description
ProfilerOptions.ProfileOptions	build()
ProfilerOptions.ProfileOptions	buildPartial()
ProfilerOptions.ProfileOptions.Builder	clear()
ProfilerOptions.ProfileOptions.Builder	clearAdvancedConfiguration()
ProfilerOptions.ProfileOptions.Builder	clearDeviceTracerLevel()	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.
ProfilerOptions.ProfileOptions.Builder	clearDeviceType()	Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
ProfilerOptions.ProfileOptions.Builder	clearDurationMs()	The local profiler collects `duration_ms` milliseconds of data.
ProfilerOptions.ProfileOptions.Builder	clearEnableHloProto()	Whether serialize hlo_proto when XLA is used.
ProfilerOptions.ProfileOptions.Builder	clearHostTracerLevel()	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).
ProfilerOptions.ProfileOptions.Builder	clearIncludeDatasetOps()	We don't collect the dataset ops by default for better trace-viewer scalability.
ProfilerOptions.ProfileOptions.Builder	clearOverrideHostname()	If set, this hostname will be used to name the profile file.
ProfilerOptions.ProfileOptions.Builder	clearPythonTracerLevel()	Whether enable python function calls tracing.
ProfilerOptions.ProfileOptions.Builder	clearRaiseErrorOnStartFailure()	bool raise_error_on_start_failure = 13;
ProfilerOptions.ProfileOptions.Builder	clearRepositoryPath()	Directory to save profile data to.
ProfilerOptions.ProfileOptions.Builder	clearSessionId()	Identifier of the profiling session.
ProfilerOptions.ProfileOptions.Builder	clearStartTimestampNs()	The local profiler starts profiling at this Unix timestamp in nanoseconds.
ProfilerOptions.ProfileOptions.Builder	clearTraceOptions()	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.Builder	clearVersion()	Some default value of option are not proto3 default value.
boolean	containsAdvancedConfiguration(String key)	Advanced configuration for the profiler contains a map of config name to config value.
Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue>	getAdvancedConfiguration()	Deprecated.
int	getAdvancedConfigurationCount()	Advanced configuration for the profiler contains a map of config name to config value.
Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue>	getAdvancedConfigurationMap()	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.AdvancedConfigValue	getAdvancedConfigurationOrDefault(String key, ProfilerOptions.ProfileOptions.AdvancedConfigValue defaultValue)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.AdvancedConfigValue	getAdvancedConfigurationOrThrow(String key)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
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.
ProfilerOptions.ProfileOptions.DeviceType	getDeviceType()	Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
int	getDeviceTypeValue()	Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
long	getDurationMs()	The local profiler collects `duration_ms` milliseconds of data.
boolean	getEnableHloProto()	Whether serialize hlo_proto when XLA is used.
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).
boolean	getIncludeDatasetOps()	We don't collect the dataset ops by default for better trace-viewer scalability.
Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue>	getMutableAdvancedConfiguration()	Deprecated.
String	getOverrideHostname()	If set, this hostname will be used to name the profile file.
ByteString	getOverrideHostnameBytes()	If set, this hostname will be used to name the profile file.
int	getPythonTracerLevel()	Whether enable python function calls tracing.
boolean	getRaiseErrorOnStartFailure()	bool raise_error_on_start_failure = 13;
String	getRepositoryPath()	Directory to save profile data to.
ByteString	getRepositoryPathBytes()	Directory to save profile data to.
String	getSessionId()	Identifier of the profiling session.
ByteString	getSessionIdBytes()	Identifier of the profiling session.
long	getStartTimestampNs()	The local profiler starts profiling at this Unix timestamp in nanoseconds.
ProfilerOptions.ProfileOptions.TraceOptions	getTraceOptions()	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.TraceOptions.Builder	getTraceOptionsBuilder()	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.TraceOptionsOrBuilder	getTraceOptionsOrBuilder()	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
int	getVersion()	Some default value of option are not proto3 default value.
boolean	hasTraceOptions()	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
final boolean	isInitialized()
ProfilerOptions.ProfileOptions.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ProfilerOptions.ProfileOptions.Builder	mergeFrom(Message other)
ProfilerOptions.ProfileOptions.Builder	mergeFrom(ProfilerOptions.ProfileOptions other)
ProfilerOptions.ProfileOptions.Builder	mergeTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions value)	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.Builder	putAdvancedConfiguration(String key, ProfilerOptions.ProfileOptions.AdvancedConfigValue value)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.AdvancedConfigValue.Builder	putAdvancedConfigurationBuilderIfAbsent(String key)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.Builder	putAllAdvancedConfiguration(Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> values)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.Builder	removeAdvancedConfiguration(String key)	Advanced configuration for the profiler contains a map of config name to config value.
ProfilerOptions.ProfileOptions.Builder	setDeviceTracerLevel(int value)	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.
ProfilerOptions.ProfileOptions.Builder	setDeviceType(ProfilerOptions.ProfileOptions.DeviceType value)	Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
ProfilerOptions.ProfileOptions.Builder	setDeviceTypeValue(int value)	Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
ProfilerOptions.ProfileOptions.Builder	setDurationMs(long value)	The local profiler collects `duration_ms` milliseconds of data.
ProfilerOptions.ProfileOptions.Builder	setEnableHloProto(boolean value)	Whether serialize hlo_proto when XLA is used.
ProfilerOptions.ProfileOptions.Builder	setHostTracerLevel(int value)	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).
ProfilerOptions.ProfileOptions.Builder	setIncludeDatasetOps(boolean value)	We don't collect the dataset ops by default for better trace-viewer scalability.
ProfilerOptions.ProfileOptions.Builder	setOverrideHostname(String value)	If set, this hostname will be used to name the profile file.
ProfilerOptions.ProfileOptions.Builder	setOverrideHostnameBytes(ByteString value)	If set, this hostname will be used to name the profile file.
ProfilerOptions.ProfileOptions.Builder	setPythonTracerLevel(int value)	Whether enable python function calls tracing.
ProfilerOptions.ProfileOptions.Builder	setRaiseErrorOnStartFailure(boolean value)	bool raise_error_on_start_failure = 13;
ProfilerOptions.ProfileOptions.Builder	setRepositoryPath(String value)	Directory to save profile data to.
ProfilerOptions.ProfileOptions.Builder	setRepositoryPathBytes(ByteString value)	Directory to save profile data to.
ProfilerOptions.ProfileOptions.Builder	setSessionId(String value)	Identifier of the profiling session.
ProfilerOptions.ProfileOptions.Builder	setSessionIdBytes(ByteString value)	Identifier of the profiling session.
ProfilerOptions.ProfileOptions.Builder	setStartTimestampNs(long value)	The local profiler starts profiling at this Unix timestamp in nanoseconds.
ProfilerOptions.ProfileOptions.Builder	setTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions value)	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.Builder	setTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions.Builder builderForValue)	.tensorflow.ProfileOptions.TraceOptions trace_options = 11;
ProfilerOptions.ProfileOptions.Builder	setVersion(int value)	Some default value of option are not proto3 default value.

Methods inherited from class GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

internalGetMutableMapFieldReflection

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

clear

public ProfilerOptions.ProfileOptions.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

getDefaultInstanceForType

public ProfilerOptions.ProfileOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ProfilerOptions.ProfileOptions build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ProfilerOptions.ProfileOptions buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

mergeFrom

public ProfilerOptions.ProfileOptions.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

mergeFrom

public ProfilerOptions.ProfileOptions.Builder mergeFrom(ProfilerOptions.ProfileOptions other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

mergeFrom

public ProfilerOptions.ProfileOptions.Builder mergeFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ProfilerOptions.ProfileOptions.Builder>

Throws:

IOException

getVersion

public 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;

Specified by:

getVersion in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The version.

setVersion

public ProfilerOptions.ProfileOptions.Builder setVersion(int value)

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;

Parameters:

value - The version to set.

Returns:

This builder for chaining.

clearVersion

public ProfilerOptions.ProfileOptions.Builder clearVersion()

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:

This builder for chaining.

getDeviceTypeValue

public 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;

Specified by:

getDeviceTypeValue in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The enum numeric value on the wire for deviceType.

setDeviceTypeValue

public ProfilerOptions.ProfileOptions.Builder setDeviceTypeValue(int value)

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;

Parameters:

value - The enum numeric value on the wire for deviceType to set.

Returns:

This builder for chaining.

getDeviceType

public 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;

Specified by:

getDeviceType in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The deviceType.

setDeviceType

public ProfilerOptions.ProfileOptions.Builder setDeviceType(ProfilerOptions.ProfileOptions.DeviceType value)

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;

Parameters:

value - The deviceType to set.

Returns:

This builder for chaining.

clearDeviceType

public ProfilerOptions.ProfileOptions.Builder clearDeviceType()

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:

This builder for chaining.

getIncludeDatasetOps

public 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;

Specified by:

getIncludeDatasetOps in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The includeDatasetOps.

setIncludeDatasetOps

public ProfilerOptions.ProfileOptions.Builder setIncludeDatasetOps(boolean value)

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;

Parameters:

value - The includeDatasetOps to set.

Returns:

This builder for chaining.

clearIncludeDatasetOps

public ProfilerOptions.ProfileOptions.Builder clearIncludeDatasetOps()

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:

This builder for chaining.

getHostTracerLevel

public 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;

Specified by:

getHostTracerLevel in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The hostTracerLevel.

setHostTracerLevel

public ProfilerOptions.ProfileOptions.Builder setHostTracerLevel(int value)

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;

Parameters:

value - The hostTracerLevel to set.

Returns:

This builder for chaining.

clearHostTracerLevel

public ProfilerOptions.ProfileOptions.Builder clearHostTracerLevel()

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:

This builder for chaining.

getDeviceTracerLevel

public 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;

Specified by:

getDeviceTracerLevel in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The deviceTracerLevel.

setDeviceTracerLevel

public ProfilerOptions.ProfileOptions.Builder setDeviceTracerLevel(int value)

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;

Parameters:

value - The deviceTracerLevel to set.

Returns:

This builder for chaining.

clearDeviceTracerLevel

public ProfilerOptions.ProfileOptions.Builder clearDeviceTracerLevel()

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:

This builder for chaining.

getPythonTracerLevel

public int getPythonTracerLevel()

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

uint32 python_tracer_level = 4;

Specified by:

getPythonTracerLevel in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The pythonTracerLevel.

setPythonTracerLevel

public ProfilerOptions.ProfileOptions.Builder setPythonTracerLevel(int value)

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

uint32 python_tracer_level = 4;

Parameters:

value - The pythonTracerLevel to set.

Returns:

This builder for chaining.

clearPythonTracerLevel

public ProfilerOptions.ProfileOptions.Builder clearPythonTracerLevel()

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

uint32 python_tracer_level = 4;

Returns:

This builder for chaining.

getEnableHloProto

public boolean getEnableHloProto()

Whether serialize hlo_proto when XLA is used. (version >= 1)

bool enable_hlo_proto = 7;

Specified by:

getEnableHloProto in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The enableHloProto.

setEnableHloProto

public ProfilerOptions.ProfileOptions.Builder setEnableHloProto(boolean value)

Whether serialize hlo_proto when XLA is used. (version >= 1)

bool enable_hlo_proto = 7;

Parameters:

value - The enableHloProto to set.

Returns:

This builder for chaining.

clearEnableHloProto

public ProfilerOptions.ProfileOptions.Builder clearEnableHloProto()

Whether serialize hlo_proto when XLA is used. (version >= 1)

bool enable_hlo_proto = 7;

Returns:

This builder for chaining.

getStartTimestampNs

public long getStartTimestampNs()

The local profiler starts profiling at this Unix timestamp in nanoseconds.

uint64 start_timestamp_ns = 8;

Specified by:

getStartTimestampNs in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The startTimestampNs.

setStartTimestampNs

public ProfilerOptions.ProfileOptions.Builder setStartTimestampNs(long value)

The local profiler starts profiling at this Unix timestamp in nanoseconds.

uint64 start_timestamp_ns = 8;

Parameters:

value - The startTimestampNs to set.

Returns:

This builder for chaining.

clearStartTimestampNs

public ProfilerOptions.ProfileOptions.Builder clearStartTimestampNs()

The local profiler starts profiling at this Unix timestamp in nanoseconds.

uint64 start_timestamp_ns = 8;

Returns:

This builder for chaining.

getDurationMs

public long getDurationMs()

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

uint64 duration_ms = 9;

Specified by:

getDurationMs in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The durationMs.

setDurationMs

public ProfilerOptions.ProfileOptions.Builder setDurationMs(long value)

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

uint64 duration_ms = 9;

Parameters:

value - The durationMs to set.

Returns:

This builder for chaining.

clearDurationMs

public ProfilerOptions.ProfileOptions.Builder clearDurationMs()

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

uint64 duration_ms = 9;

Returns:

This builder for chaining.

getRepositoryPath

public String getRepositoryPath()

Directory to save profile data to. No-op when empty.

string repository_path = 10;

Specified by:

getRepositoryPath in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The repositoryPath.

getRepositoryPathBytes

public ByteString getRepositoryPathBytes()

Directory to save profile data to. No-op when empty.

string repository_path = 10;

Specified by:

getRepositoryPathBytes in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The bytes for repositoryPath.

setRepositoryPath

public ProfilerOptions.ProfileOptions.Builder setRepositoryPath(String value)

Directory to save profile data to. No-op when empty.

string repository_path = 10;

Parameters:

value - The repositoryPath to set.

Returns:

This builder for chaining.

clearRepositoryPath

public ProfilerOptions.ProfileOptions.Builder clearRepositoryPath()

Directory to save profile data to. No-op when empty.

string repository_path = 10;

Returns:

This builder for chaining.

setRepositoryPathBytes

public ProfilerOptions.ProfileOptions.Builder setRepositoryPathBytes(ByteString value)

Directory to save profile data to. No-op when empty.

string repository_path = 10;

Parameters:

value - The bytes for repositoryPath to set.

Returns:

This builder for chaining.

hasTraceOptions

public boolean hasTraceOptions()

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

Specified by:

hasTraceOptions in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

Whether the traceOptions field is set.

getTraceOptions

public ProfilerOptions.ProfileOptions.TraceOptions getTraceOptions()

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

Specified by:

getTraceOptions in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The traceOptions.

setTraceOptions

public ProfilerOptions.ProfileOptions.Builder setTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions value)

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

setTraceOptions

public ProfilerOptions.ProfileOptions.Builder setTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions.Builder builderForValue)

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

mergeTraceOptions

public ProfilerOptions.ProfileOptions.Builder mergeTraceOptions(ProfilerOptions.ProfileOptions.TraceOptions value)

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

clearTraceOptions

public ProfilerOptions.ProfileOptions.Builder clearTraceOptions()

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

getTraceOptionsBuilder

public ProfilerOptions.ProfileOptions.TraceOptions.Builder getTraceOptionsBuilder()

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

getTraceOptionsOrBuilder

public ProfilerOptions.ProfileOptions.TraceOptionsOrBuilder getTraceOptionsOrBuilder()

.tensorflow.ProfileOptions.TraceOptions trace_options = 11;

Specified by:

getTraceOptionsOrBuilder in interface ProfilerOptions.ProfileOptionsOrBuilder

getAdvancedConfigurationCount

public int getAdvancedConfigurationCount()

Description copied from interface: ProfilerOptions.ProfileOptionsOrBuilder

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;

Specified by:

getAdvancedConfigurationCount in interface ProfilerOptions.ProfileOptionsOrBuilder

containsAdvancedConfiguration

public 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;

Specified by:

containsAdvancedConfiguration in interface ProfilerOptions.ProfileOptionsOrBuilder

getAdvancedConfiguration

@Deprecated
public Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> getAdvancedConfiguration()

Deprecated.

Use getAdvancedConfigurationMap() instead.

Specified by:

getAdvancedConfiguration in interface ProfilerOptions.ProfileOptionsOrBuilder

getAdvancedConfigurationMap

public 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;

Specified by:

getAdvancedConfigurationMap in interface ProfilerOptions.ProfileOptionsOrBuilder

getAdvancedConfigurationOrDefault

public 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;

Specified by:

getAdvancedConfigurationOrDefault in interface ProfilerOptions.ProfileOptionsOrBuilder

getAdvancedConfigurationOrThrow

public 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;

Specified by:

getAdvancedConfigurationOrThrow in interface ProfilerOptions.ProfileOptionsOrBuilder

clearAdvancedConfiguration

public ProfilerOptions.ProfileOptions.Builder clearAdvancedConfiguration()

removeAdvancedConfiguration

public ProfilerOptions.ProfileOptions.Builder removeAdvancedConfiguration(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;

getMutableAdvancedConfiguration

@Deprecated
public Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> getMutableAdvancedConfiguration()

Deprecated.

Use alternate mutation accessors instead.

putAdvancedConfiguration

public ProfilerOptions.ProfileOptions.Builder putAdvancedConfiguration(String key,
 ProfilerOptions.ProfileOptions.AdvancedConfigValue value)

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;

putAllAdvancedConfiguration

public ProfilerOptions.ProfileOptions.Builder putAllAdvancedConfiguration(Map<String, ProfilerOptions.ProfileOptions.AdvancedConfigValue> values)

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;

putAdvancedConfigurationBuilderIfAbsent

public ProfilerOptions.ProfileOptions.AdvancedConfigValue.Builder putAdvancedConfigurationBuilderIfAbsent(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

public boolean getRaiseErrorOnStartFailure()

bool raise_error_on_start_failure = 13;

Specified by:

getRaiseErrorOnStartFailure in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The raiseErrorOnStartFailure.

setRaiseErrorOnStartFailure

public ProfilerOptions.ProfileOptions.Builder setRaiseErrorOnStartFailure(boolean value)

bool raise_error_on_start_failure = 13;

Parameters:

value - The raiseErrorOnStartFailure to set.

Returns:

This builder for chaining.

clearRaiseErrorOnStartFailure

public ProfilerOptions.ProfileOptions.Builder clearRaiseErrorOnStartFailure()

bool raise_error_on_start_failure = 13;

Returns:

This builder for chaining.

getSessionId

public 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;

Specified by:

getSessionId in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The sessionId.

getSessionIdBytes

public 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;

Specified by:

getSessionIdBytes in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The bytes for sessionId.

setSessionId

public ProfilerOptions.ProfileOptions.Builder setSessionId(String value)

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;

Parameters:

value - The sessionId to set.

Returns:

This builder for chaining.

clearSessionId

public ProfilerOptions.ProfileOptions.Builder clearSessionId()

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:

This builder for chaining.

setSessionIdBytes

public ProfilerOptions.ProfileOptions.Builder setSessionIdBytes(ByteString value)

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;

Parameters:

value - The bytes for sessionId to set.

Returns:

This builder for chaining.

getOverrideHostname

public String getOverrideHostname()

If set, this hostname will be used to name the profile file.

string override_hostname = 15;

Specified by:

getOverrideHostname in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The overrideHostname.

getOverrideHostnameBytes

public ByteString getOverrideHostnameBytes()

If set, this hostname will be used to name the profile file.

string override_hostname = 15;

Specified by:

getOverrideHostnameBytes in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The bytes for overrideHostname.

setOverrideHostname

public ProfilerOptions.ProfileOptions.Builder setOverrideHostname(String value)

If set, this hostname will be used to name the profile file.

string override_hostname = 15;

Parameters:

value - The overrideHostname to set.

Returns:

This builder for chaining.

clearOverrideHostname

public ProfilerOptions.ProfileOptions.Builder clearOverrideHostname()

If set, this hostname will be used to name the profile file.

string override_hostname = 15;

Returns:

This builder for chaining.

setOverrideHostnameBytes

public ProfilerOptions.ProfileOptions.Builder setOverrideHostnameBytes(ByteString value)

If set, this hostname will be used to name the profile file.

string override_hostname = 15;

Parameters:

value - The bytes for overrideHostname to set.

Returns:

This builder for chaining.