ProfileOptions

public final class ProfileOptions

 Next ID: 11

Protobuf type tensorflow.ProfileOptions

Nested Classes

class	ProfileOptions.Builder		Next ID: 11 Protobuf type `tensorflow.ProfileOptions`
enum	ProfileOptions.DeviceType		Protobuf enum `tensorflow.ProfileOptions.DeviceType`

Constants

int	DEVICE_TRACER_LEVEL_FIELD_NUMBER
int	DEVICE_TYPE_FIELD_NUMBER
int	DURATION_MS_FIELD_NUMBER
int	ENABLE_HLO_PROTO_FIELD_NUMBER
int	HOST_TRACER_LEVEL_FIELD_NUMBER
int	INCLUDE_DATASET_OPS_FIELD_NUMBER
int	PYTHON_TRACER_LEVEL_FIELD_NUMBER
int	REPOSITORY_PATH_FIELD_NUMBER
int	START_TIMESTAMP_NS_FIELD_NUMBER
int	VERSION_FIELD_NUMBER

Public Methods

boolean	equals(Object obj)
static ProfileOptions	getDefaultInstance()
ProfileOptions	getDefaultInstanceForType()
final static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getDeviceTracerLevel() Levels of device tracing: (version >= 1) - Level 0 is used to disable device traces.
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.
boolean	getIncludeDatasetOps() We don't collect the dataset ops by default for better trace-viewer scalability.
	getParserForType()
int	getPythonTracerLevel() Whether enable python function calls tracing.
String	getRepositoryPath() Directory to save profile data to.
com.google.protobuf.ByteString	getRepositoryPathBytes() Directory to save profile data to.
int	getSerializedSize()
long	getStartTimestampNs() The local profiler starts profiling at this Unix timestamp in nanoseconds.
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getVersion() Some default value of option are not proto3 default value.
int	hashCode()
final boolean	isInitialized()
static ProfileOptions.Builder	newBuilder(ProfileOptions prototype)
static ProfileOptions.Builder	newBuilder()
ProfileOptions.Builder	newBuilderForType()
static ProfileOptions	parseDelimitedFrom(InputStream input)
static ProfileOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProfileOptions	parseFrom(ByteBuffer data)
static ProfileOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProfileOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProfileOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static ProfileOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProfileOptions	parseFrom(com.google.protobuf.ByteString data)
static ProfileOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProfileOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static	parser()
ProfileOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Inherited Methods

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface org.tensorflow.proto.profiler.ProfileOptionsOrBuilder

abstract int	getDeviceTracerLevel() Levels of device tracing: (version >= 1) - Level 0 is used to disable device traces.
abstract ProfileOptions.DeviceType	getDeviceType() Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
abstract int	getDeviceTypeValue() Device type to profile/trace: (version >= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
abstract long	getDurationMs() The local profiler collects `duration_ms` milliseconds of data.
abstract boolean	getEnableHloProto() Whether serialize hlo_proto when XLA is used.
abstract int	getHostTracerLevel() Levels of host tracing: (version >= 1) - Level 0 is used to disable host traces.
abstract boolean	getIncludeDatasetOps() We don't collect the dataset ops by default for better trace-viewer scalability.
abstract int	getPythonTracerLevel() Whether enable python function calls tracing.
abstract String	getRepositoryPath() Directory to save profile data to.
abstract com.google.protobuf.ByteString	getRepositoryPathBytes() Directory to save profile data to.
abstract long	getStartTimestampNs() The local profiler starts profiling at this Unix timestamp in nanoseconds.
abstract int	getVersion() Some default value of option are not proto3 default value.

Constants

public static final int DEVICE_TRACER_LEVEL_FIELD_NUMBER

Constant Value: 3

public static final int DEVICE_TYPE_FIELD_NUMBER

Constant Value: 6

public static final int DURATION_MS_FIELD_NUMBER

Constant Value: 9

public static final int ENABLE_HLO_PROTO_FIELD_NUMBER

Constant Value: 7

public static final int HOST_TRACER_LEVEL_FIELD_NUMBER

Constant Value: 2

public static final int INCLUDE_DATASET_OPS_FIELD_NUMBER

Constant Value: 1

public static final int PYTHON_TRACER_LEVEL_FIELD_NUMBER

Constant Value: 4

public static final int REPOSITORY_PATH_FIELD_NUMBER

Constant Value: 10

public static final int START_TIMESTAMP_NS_FIELD_NUMBER

Constant Value: 8

public static final int VERSION_FIELD_NUMBER

Constant Value: 5

Public Methods

public boolean equals (Object obj)

public static ProfileOptions getDefaultInstance ()

public ProfileOptions getDefaultInstanceForType ()

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()

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;

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

.tensorflow.ProfileOptions.DeviceType device_type = 6;

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.

.tensorflow.ProfileOptions.DeviceType device_type = 6;

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;

public boolean getEnableHloProto ()

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

bool enable_hlo_proto = 7;

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;

public boolean getIncludeDatasetOps ()

 We don't collect the dataset ops by default for better trace-viewer
 scalability. The caller can mannually set this field to include the ops.

bool include_dataset_ops = 1;

public getParserForType ()

public int getPythonTracerLevel ()

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

uint32 python_tracer_level = 4;

public String getRepositoryPath ()

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

string repository_path = 10;

public com.google.protobuf.ByteString getRepositoryPathBytes ()

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

string repository_path = 10;

public int getSerializedSize ()

public long getStartTimestampNs ()

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

uint64 start_timestamp_ns = 8;

public final com.google.protobuf.UnknownFieldSet getUnknownFields ()

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;

public int hashCode ()

public final boolean isInitialized ()

public static ProfileOptions.Builder newBuilder (ProfileOptions prototype)

public static ProfileOptions.Builder newBuilder ()

public ProfileOptions.Builder newBuilderForType ()

public static ProfileOptions parseDelimitedFrom (InputStream input)

Throws

IOException

public static ProfileOptions parseDelimitedFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

IOException

public static ProfileOptions parseFrom (ByteBuffer data)

Throws

InvalidProtocolBufferException

public static ProfileOptions parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

IOException

public static ProfileOptions parseFrom (ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

InvalidProtocolBufferException

public static ProfileOptions parseFrom (com.google.protobuf.CodedInputStream input)

Throws

IOException

public static ProfileOptions parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

InvalidProtocolBufferException

public static ProfileOptions parseFrom (com.google.protobuf.ByteString data)

Throws

InvalidProtocolBufferException

public static ProfileOptions parseFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

IOException

public static ProfileOptions parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws

InvalidProtocolBufferException

public static parser ()

public ProfileOptions.Builder toBuilder ()

public void writeTo (com.google.protobuf.CodedOutputStream output)

Throws

IOException