Class ProfilerOptions.ProfileOptions.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ProfilerOptions.ProfileOptions.Builder>
com.google.protobuf.GeneratedMessageV3.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 GeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
implements ProfilerOptions.ProfileOptionsOrBuilder
Next ID: 11Protobuf type
tensorflow.ProfileOptions-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(Descriptors.FieldDescriptor field, Object value) build()clear()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.Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.The local profiler collects `duration_ms` milliseconds of data.Whether serialize hlo_proto when XLA is used.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).We don't collect the dataset ops by default for better trace-viewer scalability.Whether enable python function calls tracing.Directory to save profile data to.The local profiler starts profiling at this Unix timestamp in nanoseconds.Some default value of option are not proto3 default value.clone()static final Descriptors.DescriptorintLevels 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.Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.intDevice type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.longThe local profiler collects `duration_ms` milliseconds of data.booleanWhether serialize hlo_proto when XLA is used.intLevels 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).booleanWe don't collect the dataset ops by default for better trace-viewer scalability.intWhether enable python function calls tracing.Directory to save profile data to.Directory to save profile data to.longThe local profiler starts profiling at this Unix timestamp in nanoseconds.intSome default value of option are not proto3 default value.protected GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) mergeUnknownFields(UnknownFieldSet unknownFields) 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.Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.setDeviceTypeValue(int value) Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.setDurationMs(long value) The local profiler collects `duration_ms` milliseconds of data.setEnableHloProto(boolean value) Whether serialize hlo_proto when XLA is used.setField(Descriptors.FieldDescriptor field, Object value) 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. - Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high level program execution details (expensive TF ops, XLA ops, etc).setIncludeDatasetOps(boolean value) We don't collect the dataset ops by default for better trace-viewer scalability.setPythonTracerLevel(int value) Whether enable python function calls tracing.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) setRepositoryPath(String value) Directory to save profile data to.setRepositoryPathBytes(ByteString value) Directory to save profile data to.setStartTimestampNs(long value) The local profiler starts profiling at this Unix timestamp in nanoseconds.setUnknownFields(UnknownFieldSet unknownFields) setVersion(int value) Some default value of option are not proto3 default value.Methods inherited from class GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface MessageLite.Builder
mergeFromMethods inherited from interface MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
- Specified by:
internalGetFieldAccessorTablein classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
clear
- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder- Overrides:
clearin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
getDescriptorForType
- Specified by:
getDescriptorForTypein interfaceMessage.Builder- Specified by:
getDescriptorForTypein interfaceMessageOrBuilder- Overrides:
getDescriptorForTypein classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-
build
- Specified by:
buildin interfaceMessage.Builder- Specified by:
buildin interfaceMessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfaceMessage.Builder- Specified by:
buildPartialin interfaceMessageLite.Builder
-
clone
- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
setField
public ProfilerOptions.ProfileOptions.Builder setField(Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfaceMessage.Builder- Overrides:
setFieldin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
clearField
- Specified by:
clearFieldin interfaceMessage.Builder- Overrides:
clearFieldin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
clearOneof
- Specified by:
clearOneofin interfaceMessage.Builder- Overrides:
clearOneofin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
setRepeatedField
public ProfilerOptions.ProfileOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfaceMessage.Builder- Overrides:
setRepeatedFieldin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
addRepeatedField
public ProfilerOptions.ProfileOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfaceMessage.Builder- Overrides:
addRepeatedFieldin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfaceMessage.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<ProfilerOptions.ProfileOptions.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
mergeFrom
public ProfilerOptions.ProfileOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessage.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:
getVersionin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The version.
-
setVersion
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
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:
getDeviceTypeValuein interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The enum numeric value on the wire for deviceType.
-
setDeviceTypeValue
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
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:
getDeviceTypein interfaceProfilerOptions.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
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:
getIncludeDatasetOpsin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The includeDatasetOps.
-
setIncludeDatasetOps
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
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. - 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;- Specified by:
getHostTracerLevelin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The hostTracerLevel.
-
setHostTracerLevel
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;- Parameters:
value- The hostTracerLevel to set.- Returns:
- This builder for chaining.
-
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. - 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;- 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:
getDeviceTracerLevelin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The deviceTracerLevel.
-
setDeviceTracerLevel
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
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:
getPythonTracerLevelin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The pythonTracerLevel.
-
setPythonTracerLevel
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
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:
getEnableHloProtoin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The enableHloProto.
-
setEnableHloProto
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
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:
getStartTimestampNsin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The startTimestampNs.
-
setStartTimestampNs
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
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:
getDurationMsin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The durationMs.
-
setDurationMs
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
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
Directory to save profile data to. No-op when empty.
string repository_path = 10;- Specified by:
getRepositoryPathin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The repositoryPath.
-
getRepositoryPathBytes
Directory to save profile data to. No-op when empty.
string repository_path = 10;- Specified by:
getRepositoryPathBytesin interfaceProfilerOptions.ProfileOptionsOrBuilder- Returns:
- The bytes for repositoryPath.
-
setRepositoryPath
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
Directory to save profile data to. No-op when empty.
string repository_path = 10;- Returns:
- This builder for chaining.
-
setRepositoryPathBytes
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.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfaceMessage.Builder- Overrides:
setUnknownFieldsin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-
mergeUnknownFields
public final ProfilerOptions.ProfileOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfaceMessage.Builder- Overrides:
mergeUnknownFieldsin classGeneratedMessageV3.Builder<ProfilerOptions.ProfileOptions.Builder>
-