Class ProfilerOptions.ProfileOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.ProfilerOptions.ProfileOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, ProfilerOptions.ProfileOptionsOrBuilder

Enclosing class:

ProfilerOptions

public static final class ProfilerOptions.ProfileOptions
extends GeneratedMessageV3
implements ProfilerOptions.ProfileOptionsOrBuilder

Next ID: 11

Protobuf type tensorflow.ProfileOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProfilerOptions.ProfileOptions.Builder	Next ID: 11
static enum	ProfilerOptions.ProfileOptions.DeviceType	Protobuf enum tensorflow.ProfileOptions.DeviceType

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEVICE_TRACER_LEVEL_FIELD_NUMBER
static final int	DEVICE_TYPE_FIELD_NUMBER
static final int	DURATION_MS_FIELD_NUMBER
static final int	ENABLE_HLO_PROTO_FIELD_NUMBER
static final int	HOST_TRACER_LEVEL_FIELD_NUMBER
static final int	INCLUDE_DATASET_OPS_FIELD_NUMBER
static final int	PYTHON_TRACER_LEVEL_FIELD_NUMBER
static final int	REPOSITORY_PATH_FIELD_NUMBER
static final int	START_TIMESTAMP_NS_FIELD_NUMBER
static final int	VERSION_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ProfilerOptions.ProfileOptions	getDefaultInstance()
ProfilerOptions.ProfileOptions	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
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. - Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high level program execution details (expensive TF ops, XLA ops, etc).
boolean	getIncludeDatasetOps()	We don't collect the dataset ops by default for better trace-viewer scalability.
Parser<ProfilerOptions.ProfileOptions>	getParserForType()
int	getPythonTracerLevel()	Whether enable python function calls tracing.
String	getRepositoryPath()	Directory to save profile data to.
ByteString	getRepositoryPathBytes()	Directory to save profile data to.
int	getSerializedSize()
long	getStartTimestampNs()	The local profiler starts profiling at this Unix timestamp in nanoseconds.
final UnknownFieldSet	getUnknownFields()
int	getVersion()	Some default value of option are not proto3 default value.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ProfilerOptions.ProfileOptions.Builder	newBuilder()
static ProfilerOptions.ProfileOptions.Builder	newBuilder(ProfilerOptions.ProfileOptions prototype)
ProfilerOptions.ProfileOptions.Builder	newBuilderForType()
protected ProfilerOptions.ProfileOptions.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ProfilerOptions.ProfileOptions	parseDelimitedFrom(InputStream input)
static ProfilerOptions.ProfileOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ProfilerOptions.ProfileOptions	parseFrom(byte[] data)
static ProfilerOptions.ProfileOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ProfilerOptions.ProfileOptions	parseFrom(ByteString data)
static ProfilerOptions.ProfileOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ProfilerOptions.ProfileOptions	parseFrom(CodedInputStream input)
static ProfilerOptions.ProfileOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ProfilerOptions.ProfileOptions	parseFrom(InputStream input)
static ProfilerOptions.ProfileOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ProfilerOptions.ProfileOptions	parseFrom(ByteBuffer data)
static ProfilerOptions.ProfileOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<ProfilerOptions.ProfileOptions>	parser()
ProfilerOptions.ProfileOptions.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

• Constant Field Values

DEVICE_TYPE_FIELD_NUMBER

public static final int DEVICE_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

INCLUDE_DATASET_OPS_FIELD_NUMBER

public static final int INCLUDE_DATASET_OPS_FIELD_NUMBER

See Also:

• Constant Field Values

HOST_TRACER_LEVEL_FIELD_NUMBER

public static final int HOST_TRACER_LEVEL_FIELD_NUMBER

See Also:

• Constant Field Values

DEVICE_TRACER_LEVEL_FIELD_NUMBER

public static final int DEVICE_TRACER_LEVEL_FIELD_NUMBER

See Also:

• Constant Field Values

PYTHON_TRACER_LEVEL_FIELD_NUMBER

public static final int PYTHON_TRACER_LEVEL_FIELD_NUMBER

See Also:

• Constant Field Values

ENABLE_HLO_PROTO_FIELD_NUMBER

public static final int ENABLE_HLO_PROTO_FIELD_NUMBER

See Also:

• Constant Field Values

START_TIMESTAMP_NS_FIELD_NUMBER

public static final int START_TIMESTAMP_NS_FIELD_NUMBER

See Also:

• Constant Field Values

DURATION_MS_FIELD_NUMBER

public static final int DURATION_MS_FIELD_NUMBER

See Also:

• Constant Field Values

REPOSITORY_PATH_FIELD_NUMBER

public static final int REPOSITORY_PATH_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.

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.

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.

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.

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:

getHostTracerLevel in interface ProfilerOptions.ProfileOptionsOrBuilder

Returns:

The hostTracerLevel.

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.

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.

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(ByteBuffer data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(ByteString data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(byte[] data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProfilerOptions.ProfileOptions parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProfilerOptions.ProfileOptions parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ProfilerOptions.ProfileOptions parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public ProfilerOptions.ProfileOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ProfilerOptions.ProfileOptions.Builder newBuilder()

newBuilder

public static ProfilerOptions.ProfileOptions.Builder newBuilder(ProfilerOptions.ProfileOptions prototype)

toBuilder

public ProfilerOptions.ProfileOptions.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ProfilerOptions.ProfileOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ProfilerOptions.ProfileOptions getDefaultInstance()

parser

public static Parser<ProfilerOptions.ProfileOptions> parser()

getParserForType

public Parser<ProfilerOptions.ProfileOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ProfilerOptions.ProfileOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder