Package org.platanios.tensorflow.proto
Class RunOptions
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.platanios.tensorflow.proto.RunOptions
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
,RunOptionsOrBuilder
public final class RunOptions extends com.google.protobuf.GeneratedMessageV3 implements RunOptionsOrBuilder
Options for a single Run() call.
Protobuf typeorg.platanios.tensorflow.proto.RunOptions
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RunOptions.Builder
Options for a single Run() call.static 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 class
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 com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEBUG_OPTIONS_FIELD_NUMBER
static int
EXPERIMENTAL_FIELD_NUMBER
static int
INTER_OP_THREAD_POOL_FIELD_NUMBER
static int
OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER
static int
REPORT_TENSOR_ALLOCATIONS_UPON_OOM_FIELD_NUMBER
static int
TIMEOUT_IN_MS_FIELD_NUMBER
static int
TRACE_LEVEL_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
DebugOptions
getDebugOptions()
EXPERIMENTAL.DebugOptionsOrBuilder
getDebugOptionsOrBuilder()
EXPERIMENTAL.static RunOptions
getDefaultInstance()
RunOptions
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
RunOptions.Experimental
getExperimental()
.org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
RunOptions.ExperimentalOrBuilder
getExperimentalOrBuilder()
.org.platanios.tensorflow.proto.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.com.google.protobuf.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()
.org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
int
getTraceLevelValue()
.org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasDebugOptions()
EXPERIMENTAL.boolean
hasExperimental()
.org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RunOptions.Builder
newBuilder()
static RunOptions.Builder
newBuilder(RunOptions prototype)
RunOptions.Builder
newBuilderForType()
protected RunOptions.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RunOptions
parseDelimitedFrom(java.io.InputStream input)
static RunOptions
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunOptions
parseFrom(byte[] data)
static RunOptions
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunOptions
parseFrom(com.google.protobuf.ByteString data)
static RunOptions
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunOptions
parseFrom(com.google.protobuf.CodedInputStream input)
static RunOptions
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunOptions
parseFrom(java.io.InputStream input)
static RunOptions
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunOptions
parseFrom(java.nio.ByteBuffer data)
static RunOptions
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunOptions>
parser()
RunOptions.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, 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 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
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 Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getTraceLevelValue
public int getTraceLevelValue()
.org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
- Specified by:
getTraceLevelValue
in interfaceRunOptionsOrBuilder
- Returns:
- The enum numeric value on the wire for traceLevel.
-
getTraceLevel
public RunOptions.TraceLevel getTraceLevel()
.org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
- Specified by:
getTraceLevel
in interfaceRunOptionsOrBuilder
- 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 interfaceRunOptionsOrBuilder
- 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 interfaceRunOptionsOrBuilder
- 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 interfaceRunOptionsOrBuilder
- Returns:
- The outputPartitionGraphs.
-
hasDebugOptions
public boolean hasDebugOptions()
EXPERIMENTAL. Options used to initialize DebuggerState, if enabled.
.org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
- Specified by:
hasDebugOptions
in interfaceRunOptionsOrBuilder
- Returns:
- Whether the debugOptions field is set.
-
getDebugOptions
public DebugOptions getDebugOptions()
EXPERIMENTAL. Options used to initialize DebuggerState, if enabled.
.org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
- Specified by:
getDebugOptions
in interfaceRunOptionsOrBuilder
- Returns:
- The debugOptions.
-
getDebugOptionsOrBuilder
public DebugOptionsOrBuilder getDebugOptionsOrBuilder()
EXPERIMENTAL. Options used to initialize DebuggerState, if enabled.
.org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
- Specified by:
getDebugOptionsOrBuilder
in interfaceRunOptionsOrBuilder
-
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 interfaceRunOptionsOrBuilder
- Returns:
- The reportTensorAllocationsUponOom.
-
hasExperimental
public boolean hasExperimental()
.org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
- Specified by:
hasExperimental
in interfaceRunOptionsOrBuilder
- Returns:
- Whether the experimental field is set.
-
getExperimental
public RunOptions.Experimental getExperimental()
.org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
- Specified by:
getExperimental
in interfaceRunOptionsOrBuilder
- Returns:
- The experimental.
-
getExperimentalOrBuilder
public RunOptions.ExperimentalOrBuilder getExperimentalOrBuilder()
.org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
- Specified by:
getExperimentalOrBuilder
in interfaceRunOptionsOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RunOptions parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RunOptions parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RunOptions parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RunOptions parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RunOptions parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RunOptions parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RunOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RunOptions.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RunOptions.Builder newBuilder()
-
newBuilder
public static RunOptions.Builder newBuilder(RunOptions prototype)
-
toBuilder
public RunOptions.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RunOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static RunOptions getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RunOptions> parser()
-
getParserForType
public com.google.protobuf.Parser<RunOptions> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RunOptions getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-