Package org.tensorflow.framework

Class RunOptions

  • All Implemented Interfaces:
    Serializable, org.nd4j.shade.protobuf.Message, org.nd4j.shade.protobuf.MessageLite, org.nd4j.shade.protobuf.MessageLiteOrBuilder, org.nd4j.shade.protobuf.MessageOrBuilder, RunOptionsOrBuilder
    public final class RunOptions
extends org.nd4j.shade.protobuf.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 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 org.nd4j.shade.protobuf.GeneratedMessageV3

        org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable, org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class org.nd4j.shade.protobuf.AbstractMessageLite

        org.nd4j.shade.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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 Object newInstance​(org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final org.nd4j.shade.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface org.nd4j.shade.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final org.nd4j.shade.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class org.nd4j.shade.protobuf.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.

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

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(org.nd4j.shade.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        writeTo in class org.nd4j.shade.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getSerializedSize in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface org.nd4j.shade.protobuf.Message
        Overrides:
        equals in class org.nd4j.shade.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface org.nd4j.shade.protobuf.Message
        Overrides:
        hashCode in class org.nd4j.shade.protobuf.AbstractMessage

      • parseFrom

        public static RunOptions parseFrom​(ByteBuffer data)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(ByteBuffer data,
                                   org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(org.nd4j.shade.protobuf.ByteString data)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(org.nd4j.shade.protobuf.ByteString data,
                                   org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(byte[] data)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(byte[] data,
                                   org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RunOptions parseFrom​(org.nd4j.shade.protobuf.CodedInputStream input,
                                   org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public RunOptions.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.MessageLite

      • toBuilder

        public RunOptions.Builder toBuilder()
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.Message
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.MessageLite

      • newBuilderForType

        protected RunOptions.Builder newBuilderForType​(org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static RunOptions getDefaultInstance()

      • parser

        public static org.nd4j.shade.protobuf.Parser<RunOptions> parser()

      • getParserForType

        public org.nd4j.shade.protobuf.Parser<RunOptions> getParserForType()
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getParserForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RunOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageOrBuilder