Package org.tensorflow.framework

Class ConfigProto.Experimental

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ConfigProto.ExperimentalOrBuilder
    Enclosing class:
    ConfigProto
    public static final class ConfigProto.Experimental
extends com.google.protobuf.GeneratedMessageV3
implements ConfigProto.ExperimentalOrBuilder
     Everything inside Experimental is subject to change and is not subject
 to API stability guarantees in
 https://www.tensorflow.org/guide/version_compat.
    Protobuf type tensorflow.ConfigProto.Experimental
    See Also:
    Serialized Form

    • Field Detail

      • COLLECTIVE_GROUP_LEADER_FIELD_NUMBER

        public static final int COLLECTIVE_GROUP_LEADER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXECUTOR_TYPE_FIELD_NUMBER

        public static final int EXECUTOR_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RECV_BUF_MAX_CHUNK_FIELD_NUMBER

        public static final int RECV_BUF_MAX_CHUNK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_NUMA_AFFINITY_FIELD_NUMBER

        public static final int USE_NUMA_AFFINITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COLLECTIVE_DETERMINISTIC_SEQUENTIAL_EXECUTION_FIELD_NUMBER

        public static final int COLLECTIVE_DETERMINISTIC_SEQUENTIAL_EXECUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COLLECTIVE_NCCL_FIELD_NUMBER

        public static final int COLLECTIVE_NCCL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHARE_SESSION_STATE_IN_CLUSTERSPEC_PROPAGATION_FIELD_NUMBER

        public static final int SHARE_SESSION_STATE_IN_CLUSTERSPEC_PROPAGATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_THREAD_SPINNING_FIELD_NUMBER

        public static final int DISABLE_THREAD_SPINNING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHARE_CLUSTER_DEVICES_IN_SESSION_FIELD_NUMBER

        public static final int SHARE_CLUSTER_DEVICES_IN_SESSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SESSION_METADATA_FIELD_NUMBER

        public static final int SESSION_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPTIMIZE_FOR_STATIC_GRAPH_FIELD_NUMBER

        public static final int OPTIMIZE_FOR_STATIC_GRAPH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_MLIR_BRIDGE_FIELD_NUMBER

        public static final int ENABLE_MLIR_BRIDGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER

        public static final int DISABLE_OUTPUT_PARTITION_GRAPHS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • XLA_FUSION_AUTOTUNER_THRESH_FIELD_NUMBER

        public static final int XLA_FUSION_AUTOTUNER_THRESH_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.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 class com.google.protobuf.GeneratedMessageV3

      • getCollectiveGroupLeaderBytes

        public com.google.protobuf.ByteString getCollectiveGroupLeaderBytes()
         Task name for group resolution.
        string collective_group_leader = 1;
        Specified by:
        getCollectiveGroupLeaderBytes in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The bytes for collectiveGroupLeader.

      • getExecutorType

        public java.lang.String getExecutorType()
         Which executor to use, the default executor will be used
 if it is an empty string or "DEFAULT"
        string executor_type = 3;
        Specified by:
        getExecutorType in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The executorType.

      • getExecutorTypeBytes

        public com.google.protobuf.ByteString getExecutorTypeBytes()
         Which executor to use, the default executor will be used
 if it is an empty string or "DEFAULT"
        string executor_type = 3;
        Specified by:
        getExecutorTypeBytes in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The bytes for executorType.

      • getRecvBufMaxChunk

        public int getRecvBufMaxChunk()
         Guidance to formatting of large RecvBuf fields for transfer.
 Any positive value sets the max chunk size.  0 defaults to 4096.
 Any negative value indicates no max, i.e. one chunk only.
        int32 recv_buf_max_chunk = 4;
        Specified by:
        getRecvBufMaxChunk in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The recvBufMaxChunk.

      • getUseNumaAffinity

        public boolean getUseNumaAffinity()
         If true, and supported by the platform, the runtime will attempt to
 use NUMA affinity where applicable.  One consequence will be the
 existence of as many CPU devices as there are available NUMA nodes.
        bool use_numa_affinity = 5;
        Specified by:
        getUseNumaAffinity in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The useNumaAffinity.

      • getCollectiveDeterministicSequentialExecution

        public boolean getCollectiveDeterministicSequentialExecution()
         If true, make collective op execution order sequential and deterministic
 for potentially concurrent collective instances.
        bool collective_deterministic_sequential_execution = 6;
        Specified by:
        getCollectiveDeterministicSequentialExecution in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The collectiveDeterministicSequentialExecution.

      • getCollectiveNccl

        public boolean getCollectiveNccl()
         If true, use NCCL for CollectiveOps.  This feature is highly
 experimental.
        bool collective_nccl = 7;
        Specified by:
        getCollectiveNccl in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The collectiveNccl.

      • getShareSessionStateInClusterspecPropagation

        public boolean getShareSessionStateInClusterspecPropagation()
         In the following, session state means the value of a variable, elements
 in a hash table, or any other resource, accessible by worker sessions
 held by a TF server.
 When ClusterSpec propagation is enabled, the value of
 isolate_session_state is ignored when deciding whether to share session
 states in a TF server (for backwards compatibility reasons).
 - If share_session_state_in_clusterspec_propagation is true, the session
 states are shared.
 - If share_session_state_in_clusterspec_propagation is false, session
 states are isolated.
 When clusterspec propagation is not used, the value of
 share_session_state_in_clusterspec_propagation is ignored when deciding
 whether to share session states in a TF server.
 - If isolate_session_state is true, session states are isolated.
 - If isolate_session_state is false, session states are shared.
 TODO(b/129330037): Add a single API that consistently treats
 isolate_session_state and ClusterSpec propagation.
        bool share_session_state_in_clusterspec_propagation = 8;
        Specified by:
        getShareSessionStateInClusterspecPropagation in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The shareSessionStateInClusterspecPropagation.

      • getDisableThreadSpinning

        public boolean getDisableThreadSpinning()
         If using a direct session, disable spinning while waiting for work in
 the thread pool. This may result in higher latency for completing ops,
 but in the case where there is a lot of spinning may result in lower
 CPU usage.
        bool disable_thread_spinning = 9;
        Specified by:
        getDisableThreadSpinning in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The disableThreadSpinning.

      • getShareClusterDevicesInSession

        public boolean getShareClusterDevicesInSession()
         When true, WorkerSessions are created with device attributes from the
 full cluster.
 This is helpful when a worker wants to partition a graph
 (for example during a PartitionedCallOp).
        bool share_cluster_devices_in_session = 10;
        Specified by:
        getShareClusterDevicesInSession in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The shareClusterDevicesInSession.

      • hasSessionMetadata

        public boolean hasSessionMetadata()
         Metadata about the session.
 If set, this can be used by the runtime and the Ops for debugging,
 monitoring, etc.
 NOTE: This is currently used and propagated only by the direct session.
        .tensorflow.SessionMetadata session_metadata = 11;
        Specified by:
        hasSessionMetadata in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        Whether the sessionMetadata field is set.

      • getSessionMetadata

        public SessionMetadata getSessionMetadata()
         Metadata about the session.
 If set, this can be used by the runtime and the Ops for debugging,
 monitoring, etc.
 NOTE: This is currently used and propagated only by the direct session.
        .tensorflow.SessionMetadata session_metadata = 11;
        Specified by:
        getSessionMetadata in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The sessionMetadata.

      • getOptimizeForStaticGraph

        public boolean getOptimizeForStaticGraph()
         If true, the session may treat the graph as being static for optimization
 purposes.
 If this option is set to true when a session is created, the full
 GraphDef must be passed in a single call to Session::Create(), and
 Session::Extend() may not be supported.
        bool optimize_for_static_graph = 12;
        Specified by:
        getOptimizeForStaticGraph in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The optimizeForStaticGraph.

      • getEnableMlirBridge

        public boolean getEnableMlirBridge()
         Whether to enable the MLIR-based TF->XLA bridge.
 This is a replacement to the existing bridge, and not ready for
 production usage yet.
 If this option is set to true when a session is created, MLIR is used to
 perform the set of graph transformations to put the graph in a form that
 can be executed with delegation of some computations to an accelerator.
 This builds on the model of XLA where a subset of the graph is
 encapsulated and attached to a "compile" operation, whose result is fed
 to an "execute" operation. The kernel for these operations is responsible
 to lower the encapsulated graph to a particular device.
        bool enable_mlir_bridge = 13;
        Specified by:
        getEnableMlirBridge in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The enableMlirBridge.

      • getDisableOutputPartitionGraphs

        public boolean getDisableOutputPartitionGraphs()
         If true, the session will not store an additional copy of the graph for
 each subgraph.
 If this option is set to true when a session is created, the
 `RunOptions.output_partition_graphs` options must not be set.
        bool disable_output_partition_graphs = 14;
        Specified by:
        getDisableOutputPartitionGraphs in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The disableOutputPartitionGraphs.

      • getXlaFusionAutotunerThresh

        public long getXlaFusionAutotunerThresh()
         Minimum number of batches run through the XLA graph before XLA fusion
 autotuner is enabled. Default value of zero disables the autotuner.
 The XLA fusion autotuner can improve performance by executing a heuristic
 search on the compiler parameters.
        int64 xla_fusion_autotuner_thresh = 15;
        Specified by:
        getXlaFusionAutotunerThresh in interface ConfigProto.ExperimentalOrBuilder
        Returns:
        The xlaFusionAutotunerThresh.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(java.nio.ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(java.nio.ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ConfigProto.Experimental parseDelimitedFrom​(java.io.InputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ConfigProto.Experimental parseDelimitedFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(com.google.protobuf.CodedInputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConfigProto.Experimental parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public ConfigProto.Experimental.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ConfigProto.Experimental.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ConfigProto.Experimental.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ConfigProto.Experimental> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ConfigProto.Experimental getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder