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: 11Protobuf type
tensorflow.ProfileOptions- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classNext ID: 11static enumProtobuf enumtensorflow.ProfileOptions.DeviceTypeNested classes/interfaces inherited from class GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterNested classes/interfaces inherited from class AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class AbstractMessage
memoizedSizeFields inherited from class AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic 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.intlongThe local profiler starts profiling at this Unix timestamp in nanoseconds.final UnknownFieldSetintSome default value of option are not proto3 default value.inthashCode()protected GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(ProfilerOptions.ProfileOptions prototype) protected ProfilerOptions.ProfileOptions.Builderprotected ObjectparseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) parseFrom(ByteString data) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) parseFrom(CodedInputStream input) parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) static Parser<ProfilerOptions.ProfileOptions> parser()voidwriteTo(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, writeStringNoTagMethods inherited from class AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
-
DEVICE_TYPE_FIELD_NUMBER
public static final int DEVICE_TYPE_FIELD_NUMBER- See Also:
-
INCLUDE_DATASET_OPS_FIELD_NUMBER
public static final int INCLUDE_DATASET_OPS_FIELD_NUMBER- See Also:
-
HOST_TRACER_LEVEL_FIELD_NUMBER
public static final int HOST_TRACER_LEVEL_FIELD_NUMBER- See Also:
-
DEVICE_TRACER_LEVEL_FIELD_NUMBER
public static final int DEVICE_TRACER_LEVEL_FIELD_NUMBER- See Also:
-
PYTHON_TRACER_LEVEL_FIELD_NUMBER
public static final int PYTHON_TRACER_LEVEL_FIELD_NUMBER- See Also:
-
ENABLE_HLO_PROTO_FIELD_NUMBER
public static final int ENABLE_HLO_PROTO_FIELD_NUMBER- See Also:
-
START_TIMESTAMP_NS_FIELD_NUMBER
public static final int START_TIMESTAMP_NS_FIELD_NUMBER- See Also:
-
DURATION_MS_FIELD_NUMBER
public static final int DURATION_MS_FIELD_NUMBER- See Also:
-
REPOSITORY_PATH_FIELD_NUMBER
public static final int REPOSITORY_PATH_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classGeneratedMessageV3
-
getUnknownFields
- Specified by:
getUnknownFieldsin interfaceMessageOrBuilder- Overrides:
getUnknownFieldsin classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
- Specified by:
internalGetFieldAccessorTablein classGeneratedMessageV3
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classGeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classGeneratedMessageV3
-
equals
- Specified by:
equalsin interfaceMessage- Overrides:
equalsin classAbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfaceMessage- Overrides:
hashCodein classAbstractMessage
-
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
- 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
- Throws:
IOException
-
parseFrom
public static ProfilerOptions.ProfileOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
-
newBuilder
public static ProfilerOptions.ProfileOptions.Builder newBuilder(ProfilerOptions.ProfileOptions prototype) -
toBuilder
- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
protected ProfilerOptions.ProfileOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-