Class RunOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.RunOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, RunOptionsOrBuilder

public final class RunOptions
extends GeneratedMessageV3
implements RunOptionsOrBuilder

Options for a single Run() call.

Protobuf type tensorflow.RunOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RunOptions.Builder	Options for a single Run() call.
static final class	RunOptions.Experimental	Everything inside Experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
static interface	RunOptions.ExperimentalOrBuilder
static enum	RunOptions.TraceLevel	TODO(pbar) Turn this into a TraceOptions proto which allows tracing to be controlled in a more orthogonal manner?

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	DEBUG_OPTIONS_FIELD_NUMBER
static final int	EXPERIMENTAL_FIELD_NUMBER
static final int	INTER_OP_THREAD_POOL_FIELD_NUMBER
static final int	OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER
static final int	REPORT_TENSOR_ALLOCATIONS_UPON_OOM_FIELD_NUMBER
static final int	TIMEOUT_IN_MS_FIELD_NUMBER
static final int	TRACE_LEVEL_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)
DebugOptions	getDebugOptions()	EXPERIMENTAL.
DebugOptionsOrBuilder	getDebugOptionsOrBuilder()	EXPERIMENTAL.
static RunOptions	getDefaultInstance()
RunOptions	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
RunOptions.Experimental	getExperimental()	.tensorflow.RunOptions.Experimental experimental = 8;
RunOptions.ExperimentalOrBuilder	getExperimentalOrBuilder()	.tensorflow.RunOptions.Experimental experimental = 8;
int	getInterOpThreadPool()	The thread pool to use, if session_inter_op_thread_pool is configured.
boolean	getOutputPartitionGraphs()	Whether the partition graph(s) executed by the executor(s) should be outputted via RunMetadata.
Parser<RunOptions>	getParserForType()
boolean	getReportTensorAllocationsUponOom()	When enabled, causes tensor allocation information to be included in the error message when the Run() call fails because the allocator ran out of memory (OOM).
int	getSerializedSize()
long	getTimeoutInMs()	Time to wait for operation to complete in milliseconds.
RunOptions.TraceLevel	getTraceLevel()	.tensorflow.RunOptions.TraceLevel trace_level = 1;
int	getTraceLevelValue()	.tensorflow.RunOptions.TraceLevel trace_level = 1;
final UnknownFieldSet	getUnknownFields()
boolean	hasDebugOptions()	EXPERIMENTAL.
boolean	hasExperimental()	.tensorflow.RunOptions.Experimental experimental = 8;
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RunOptions.Builder	newBuilder()
static RunOptions.Builder	newBuilder(RunOptions prototype)
RunOptions.Builder	newBuilderForType()
protected RunOptions.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static RunOptions	parseDelimitedFrom(InputStream input)
static RunOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RunOptions	parseFrom(byte[] data)
static RunOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RunOptions	parseFrom(ByteString data)
static RunOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RunOptions	parseFrom(CodedInputStream input)
static RunOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RunOptions	parseFrom(InputStream input)
static RunOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RunOptions	parseFrom(ByteBuffer data)
static RunOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<RunOptions>	parser()
RunOptions.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

TRACE_LEVEL_FIELD_NUMBER

public static final int TRACE_LEVEL_FIELD_NUMBER

See Also:

• Constant Field Values

TIMEOUT_IN_MS_FIELD_NUMBER

public static final int TIMEOUT_IN_MS_FIELD_NUMBER

See Also:

• Constant Field Values

INTER_OP_THREAD_POOL_FIELD_NUMBER

public static final int INTER_OP_THREAD_POOL_FIELD_NUMBER

See Also:

• Constant Field Values

OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER

public static final int OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER

See Also:

• Constant Field Values

DEBUG_OPTIONS_FIELD_NUMBER

public static final int DEBUG_OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

REPORT_TENSOR_ALLOCATIONS_UPON_OOM_FIELD_NUMBER

public static final int REPORT_TENSOR_ALLOCATIONS_UPON_OOM_FIELD_NUMBER

See Also:

• Constant Field Values

EXPERIMENTAL_FIELD_NUMBER

public static final int EXPERIMENTAL_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

getTraceLevelValue

public int getTraceLevelValue()

.tensorflow.RunOptions.TraceLevel trace_level = 1;

Specified by:

getTraceLevelValue in interface RunOptionsOrBuilder

Returns:

The enum numeric value on the wire for traceLevel.

getTraceLevel

public RunOptions.TraceLevel getTraceLevel()

.tensorflow.RunOptions.TraceLevel trace_level = 1;

Specified by:

getTraceLevel in interface RunOptionsOrBuilder

Returns:

The traceLevel.

getTimeoutInMs

public long getTimeoutInMs()

Time to wait for operation to complete in milliseconds.

int64 timeout_in_ms = 2;

Specified by:

getTimeoutInMs in interface RunOptionsOrBuilder

Returns:

The timeoutInMs.

getInterOpThreadPool

public int getInterOpThreadPool()

The thread pool to use, if session_inter_op_thread_pool is configured.
To use the caller thread set this to -1 - this uses the caller thread
to execute Session::Run() and thus avoids a context switch. Using the
caller thread to execute Session::Run() should be done ONLY for simple
graphs, where the overhead of an additional context switch is
comparable with the overhead of Session::Run().

int32 inter_op_thread_pool = 3;

Specified by:

getInterOpThreadPool in interface RunOptionsOrBuilder

Returns:

The interOpThreadPool.

getOutputPartitionGraphs

public boolean getOutputPartitionGraphs()

Whether the partition graph(s) executed by the executor(s) should be
outputted via RunMetadata.

bool output_partition_graphs = 5;

Specified by:

getOutputPartitionGraphs in interface RunOptionsOrBuilder

Returns:

The outputPartitionGraphs.

hasDebugOptions

public boolean hasDebugOptions()

EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.

.tensorflow.DebugOptions debug_options = 6;

Specified by:

hasDebugOptions in interface RunOptionsOrBuilder

Returns:

Whether the debugOptions field is set.

getDebugOptions

public DebugOptions getDebugOptions()

EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.

.tensorflow.DebugOptions debug_options = 6;

Specified by:

getDebugOptions in interface RunOptionsOrBuilder

Returns:

The debugOptions.

getDebugOptionsOrBuilder

public DebugOptionsOrBuilder getDebugOptionsOrBuilder()

EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.

.tensorflow.DebugOptions debug_options = 6;

Specified by:

getDebugOptionsOrBuilder in interface RunOptionsOrBuilder

getReportTensorAllocationsUponOom

public boolean getReportTensorAllocationsUponOom()

When enabled, causes tensor allocation information to be included in
the error message when the Run() call fails because the allocator ran
out of memory (OOM).
Enabling this option can slow down the Run() call.

bool report_tensor_allocations_upon_oom = 7;

Specified by:

getReportTensorAllocationsUponOom in interface RunOptionsOrBuilder

Returns:

The reportTensorAllocationsUponOom.

hasExperimental

public boolean hasExperimental()

.tensorflow.RunOptions.Experimental experimental = 8;

Specified by:

hasExperimental in interface RunOptionsOrBuilder

Returns:

Whether the experimental field is set.

getExperimental

public RunOptions.Experimental getExperimental()

.tensorflow.RunOptions.Experimental experimental = 8;

Specified by:

getExperimental in interface RunOptionsOrBuilder

Returns:

The experimental.

getExperimentalOrBuilder

public RunOptions.ExperimentalOrBuilder getExperimentalOrBuilder()

.tensorflow.RunOptions.Experimental experimental = 8;

Specified by:

getExperimentalOrBuilder in interface RunOptionsOrBuilder

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 RunOptions parseFrom(ByteBuffer data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(ByteString data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(byte[] data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunOptions parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static RunOptions parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunOptions parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunOptions parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static RunOptions parseFrom(CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static RunOptions parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public RunOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RunOptions.Builder newBuilder()

newBuilder

public static RunOptions.Builder newBuilder(RunOptions prototype)

toBuilder

public RunOptions.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RunOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RunOptions getDefaultInstance()

parser

public static Parser<RunOptions> parser()

getParserForType

public Parser<RunOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RunOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder