ProfileOptionsOrBuilder
Stay organized with collections
Save and categorize content based on your preferences.
|
Known Indirect Subclasses
|
Public Methods
|
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
|
|
|
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
|
|
|
abstract
String
|
|
|
abstract
com.google.protobuf.ByteString
|
|
|
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.
|
Public Methods
public
abstract
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;
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
abstract
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
abstract
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
abstract
boolean
getEnableHloProto
()
Whether serialize hlo_proto when XLA is used. (version >= 1)
bool enable_hlo_proto = 7;
public
abstract
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
abstract
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
abstract
int
getPythonTracerLevel
()
Whether enable python function calls tracing. Runtime overhead ensues if
enabled. Default off. (version >= 1)
uint32 python_tracer_level = 4;
public
abstract
String
getRepositoryPath
()
Directory to save profile data to. No-op when empty.
string repository_path = 10;
public
abstract
com.google.protobuf.ByteString
getRepositoryPathBytes
()
Directory to save profile data to. No-op when empty.
string repository_path = 10;
public
abstract
long
getStartTimestampNs
()
The local profiler starts profiling at this Unix timestamp in nanoseconds.
uint64 start_timestamp_ns = 8;
public
abstract
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;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-11-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2021-11-29 UTC."],[],[],null,["# ProfileOptionsOrBuilder\n\npublic interface **ProfileOptionsOrBuilder** \n\n|---|---|---|\n| Known Indirect Subclasses [ProfileOptions](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions), [ProfileOptions.Builder](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions.Builder) |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | [ProfileOptions](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions) | ``` Next ID: 11 ``` Protobuf type `tensorflow.ProfileOptions` | | [ProfileOptions.Builder](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions.Builder) | ``` Next ID: 11 ``` Protobuf type `tensorflow.ProfileOptions` | |||\n\n### Public Methods\n\n|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract int | [getDeviceTracerLevel](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getDeviceTracerLevel())() ``` Levels of device tracing: (version \u003e= 1) - Level 0 is used to disable device traces. ``` |\n| abstract [ProfileOptions.DeviceType](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions.DeviceType) | [getDeviceType](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getDeviceType())() ``` Device type to profile/trace: (version \u003e= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled. ``` |\n| abstract int | [getDeviceTypeValue](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getDeviceTypeValue())() ``` Device type to profile/trace: (version \u003e= 1) DeviceType::UNSPECIFIED: All registered device profiler will be enabled. ``` |\n| abstract long | [getDurationMs](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getDurationMs())() ``` The local profiler collects `duration_ms` milliseconds of data. ``` |\n| abstract boolean | [getEnableHloProto](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getEnableHloProto())() ``` Whether serialize hlo_proto when XLA is used. ``` |\n| abstract int | [getHostTracerLevel](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getHostTracerLevel())() ``` Levels of host tracing: (version \u003e= 1) - Level 0 is used to disable host traces. ``` |\n| abstract boolean | [getIncludeDatasetOps](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getIncludeDatasetOps())() ``` We don't collect the dataset ops by default for better trace-viewer scalability. ``` |\n| abstract int | [getPythonTracerLevel](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getPythonTracerLevel())() ``` Whether enable python function calls tracing. ``` |\n| abstract String | [getRepositoryPath](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getRepositoryPath())() ``` Directory to save profile data to. ``` |\n| abstract com.google.protobuf.ByteString | [getRepositoryPathBytes](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getRepositoryPathBytes())() ``` Directory to save profile data to. ``` |\n| abstract long | [getStartTimestampNs](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getStartTimestampNs())() ``` The local profiler starts profiling at this Unix timestamp in nanoseconds. ``` |\n| abstract int | [getVersion](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptionsOrBuilder#getVersion())() ``` Some default value of option are not proto3 default value. ``` |\n\nPublic Methods\n--------------\n\n#### public abstract int\n**getDeviceTracerLevel**\n()\n\n\u003cbr /\u003e\n\n```\n Levels of device tracing: (version \u003e= 1)\n - Level 0 is used to disable device traces.\n - Level 1 is used to enable device traces.\n - More levels might be defined for specific device for controlling the\n verbosity of the trace.\n \n```\n`uint32 device_tracer_level = 3;`\n\n\u003cbr /\u003e\n\n#### public abstract [ProfileOptions.DeviceType](/jvm/api_docs/java/org/tensorflow/proto/profiler/ProfileOptions.DeviceType)\n**getDeviceType**\n()\n\n\u003cbr /\u003e\n\n```\n Device type to profile/trace: (version \u003e= 1)\n DeviceType::UNSPECIFIED: All registered device profiler will be enabled.\n DeviceType::CPU: only CPU will be profiled.\n DeviceType::GPU: only CPU/GPU will be profiled.\n DeviceType::TPU: only CPU/TPU will be profiled.\n \n```\n`.tensorflow.ProfileOptions.DeviceType device_type = 6;`\n\n\u003cbr /\u003e\n\n#### public abstract int\n**getDeviceTypeValue**\n()\n\n\u003cbr /\u003e\n\n```\n Device type to profile/trace: (version \u003e= 1)\n DeviceType::UNSPECIFIED: All registered device profiler will be enabled.\n DeviceType::CPU: only CPU will be profiled.\n DeviceType::GPU: only CPU/GPU will be profiled.\n DeviceType::TPU: only CPU/TPU will be profiled.\n \n```\n`.tensorflow.ProfileOptions.DeviceType device_type = 6;`\n\n\u003cbr /\u003e\n\n#### public abstract long\n**getDurationMs**\n()\n\n\u003cbr /\u003e\n\n```\n The local profiler collects `duration_ms` milliseconds of data. If the\n value is 0, profiling continues until interrupted.\n \n```\n`uint64 duration_ms = 9;`\n\n\u003cbr /\u003e\n\n#### public abstract boolean\n**getEnableHloProto**\n()\n\n\u003cbr /\u003e\n\n```\n Whether serialize hlo_proto when XLA is used. (version \u003e= 1)\n \n```\n`bool enable_hlo_proto = 7;`\n\n\u003cbr /\u003e\n\n#### public abstract int\n**getHostTracerLevel**\n()\n\n\u003cbr /\u003e\n\n```\n Levels of host tracing: (version \u003e= 1)\n - Level 0 is used to disable host traces.\n - Level 1 enables tracing of only user instrumented (or default) TraceMe.\n - Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high\n level program execution details (expensive TF ops, XLA ops, etc).\n This is the default.\n - Level 3 enables tracing of all level 2 TraceMe(s) and more verbose\n (low-level) program execution details (cheap TF ops, etc).\n \n```\n`uint32 host_tracer_level = 2;`\n\n\u003cbr /\u003e\n\n#### public abstract boolean\n**getIncludeDatasetOps**\n()\n\n\u003cbr /\u003e\n\n```\n We don't collect the dataset ops by default for better trace-viewer\n scalability. The caller can mannually set this field to include the ops.\n \n```\n`bool include_dataset_ops = 1;`\n\n\u003cbr /\u003e\n\n#### public abstract int\n**getPythonTracerLevel**\n()\n\n\u003cbr /\u003e\n\n```\n Whether enable python function calls tracing. Runtime overhead ensues if\n enabled. Default off. (version \u003e= 1)\n \n```\n`uint32 python_tracer_level = 4;`\n\n\u003cbr /\u003e\n\n#### public abstract String\n**getRepositoryPath**\n()\n\n\u003cbr /\u003e\n\n```\n Directory to save profile data to. No-op when empty.\n \n```\n`string repository_path = 10;`\n\n\u003cbr /\u003e\n\n#### public abstract com.google.protobuf.ByteString\n**getRepositoryPathBytes**\n()\n\n\u003cbr /\u003e\n\n```\n Directory to save profile data to. No-op when empty.\n \n```\n`string repository_path = 10;`\n\n\u003cbr /\u003e\n\n#### public abstract long\n**getStartTimestampNs**\n()\n\n\u003cbr /\u003e\n\n```\n The local profiler starts profiling at this Unix timestamp in nanoseconds.\n \n```\n`uint64 start_timestamp_ns = 8;`\n\n\u003cbr /\u003e\n\n#### public abstract int\n**getVersion**\n()\n\n\u003cbr /\u003e\n\n```\n Some default value of option are not proto3 default value. Use this version\n to determine if we should use default option value instead of proto3\n default value.\n \n```\n`uint32 version = 5;`\n\n\u003cbr /\u003e"]]
