Class RunOptions.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, RunOptionsOrBuilder
    Enclosing class:
    RunOptions

    public static final class RunOptions.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
    implements RunOptionsOrBuilder
     Options for a single Run() call.
     
    Protobuf type org.platanios.tensorflow.proto.RunOptions
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • clear

        public RunOptions.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • getDefaultInstanceForType

        public RunOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public RunOptions build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public RunOptions buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public RunOptions.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • setField

        public RunOptions.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • clearField

        public RunOptions.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • clearOneof

        public RunOptions.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • setRepeatedField

        public RunOptions.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • addRepeatedField

        public RunOptions.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • mergeFrom

        public RunOptions.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunOptions.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • mergeFrom

        public RunOptions.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunOptions.Builder>
        Throws:
        java.io.IOException
      • getTraceLevelValue

        public int getTraceLevelValue()
        .org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
        Specified by:
        getTraceLevelValue in interface RunOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for traceLevel.
      • setTraceLevelValue

        public RunOptions.Builder setTraceLevelValue​(int value)
        .org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
        Parameters:
        value - The enum numeric value on the wire for traceLevel to set.
        Returns:
        This builder for chaining.
      • setTraceLevel

        public RunOptions.Builder setTraceLevel​(RunOptions.TraceLevel value)
        .org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
        Parameters:
        value - The traceLevel to set.
        Returns:
        This builder for chaining.
      • clearTraceLevel

        public RunOptions.Builder clearTraceLevel()
        .org.platanios.tensorflow.proto.RunOptions.TraceLevel trace_level = 1;
        Returns:
        This builder for chaining.
      • 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.
      • setTimeoutInMs

        public RunOptions.Builder setTimeoutInMs​(long value)
         Time to wait for operation to complete in milliseconds.
         
        int64 timeout_in_ms = 2;
        Parameters:
        value - The timeoutInMs to set.
        Returns:
        This builder for chaining.
      • clearTimeoutInMs

        public RunOptions.Builder clearTimeoutInMs()
         Time to wait for operation to complete in milliseconds.
         
        int64 timeout_in_ms = 2;
        Returns:
        This builder for chaining.
      • 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.
      • setInterOpThreadPool

        public RunOptions.Builder setInterOpThreadPool​(int value)
         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;
        Parameters:
        value - The interOpThreadPool to set.
        Returns:
        This builder for chaining.
      • clearInterOpThreadPool

        public RunOptions.Builder clearInterOpThreadPool()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setOutputPartitionGraphs

        public RunOptions.Builder setOutputPartitionGraphs​(boolean value)
         Whether the partition graph(s) executed by the executor(s) should be
         outputted via RunMetadata.
         
        bool output_partition_graphs = 5;
        Parameters:
        value - The outputPartitionGraphs to set.
        Returns:
        This builder for chaining.
      • clearOutputPartitionGraphs

        public RunOptions.Builder clearOutputPartitionGraphs()
         Whether the partition graph(s) executed by the executor(s) should be
         outputted via RunMetadata.
         
        bool output_partition_graphs = 5;
        Returns:
        This builder for chaining.
      • hasDebugOptions

        public boolean hasDebugOptions()
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.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.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
        Specified by:
        getDebugOptions in interface RunOptionsOrBuilder
        Returns:
        The debugOptions.
      • setDebugOptions

        public RunOptions.Builder setDebugOptions​(DebugOptions value)
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
      • setDebugOptions

        public RunOptions.Builder setDebugOptions​(DebugOptions.Builder builderForValue)
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
      • mergeDebugOptions

        public RunOptions.Builder mergeDebugOptions​(DebugOptions value)
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
      • clearDebugOptions

        public RunOptions.Builder clearDebugOptions()
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
      • getDebugOptionsBuilder

        public DebugOptions.Builder getDebugOptionsBuilder()
         EXPERIMENTAL.  Options used to initialize DebuggerState, if enabled.
         
        .org.platanios.tensorflow.proto.DebugOptions debug_options = 6;
      • 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.
      • setReportTensorAllocationsUponOom

        public RunOptions.Builder setReportTensorAllocationsUponOom​(boolean value)
         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;
        Parameters:
        value - The reportTensorAllocationsUponOom to set.
        Returns:
        This builder for chaining.
      • clearReportTensorAllocationsUponOom

        public RunOptions.Builder clearReportTensorAllocationsUponOom()
         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;
        Returns:
        This builder for chaining.
      • hasExperimental

        public boolean hasExperimental()
        .org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
        Specified by:
        hasExperimental in interface RunOptionsOrBuilder
        Returns:
        Whether the experimental field is set.
      • clearExperimental

        public RunOptions.Builder clearExperimental()
        .org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
      • getExperimentalBuilder

        public RunOptions.Experimental.Builder getExperimentalBuilder()
        .org.platanios.tensorflow.proto.RunOptions.Experimental experimental = 8;
      • setUnknownFields

        public final RunOptions.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>
      • mergeUnknownFields

        public final RunOptions.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunOptions.Builder>