Package org.tensorflow.framework

Class BatchingOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.framework.BatchingOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, BatchingOptionsOrBuilder
public final class BatchingOptions extends com.google.protobuf.GeneratedMessageV3 implements BatchingOptionsOrBuilder
Protobuf type tensorflow.BatchingOptions
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BatchingOptions.Builder
    Protobuf type tensorflow.BatchingOptions

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALLOWED_BATCH_SIZES_FIELD_NUMBER
     
    static final int
    BATCH_TIMEOUT_MICROS_FIELD_NUMBER
     
    static final int
    MAX_BATCH_SIZE_FIELD_NUMBER
     
    static final int
    MAX_ENQUEUED_BATCHES_FIELD_NUMBER
     
    static final int
    NUM_BATCH_THREADS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    int
    getAllowedBatchSizes(int index)
    Optional list of allowed batch sizes.
    int
    getAllowedBatchSizesCount()
    Optional list of allowed batch sizes.
    List<Integer>
    getAllowedBatchSizesList()
    Optional list of allowed batch sizes.
    int
    getBatchTimeoutMicros()
    Maximum number of microseconds to wait before outputting an incomplete batch.
    static BatchingOptions
    getDefaultInstance()
     
    BatchingOptions
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getMaxBatchSize()
    The maximum allowed batch size.
    int
    getMaxEnqueuedBatches()
    Maximum number of batches enqueued for processing before requests are failed fast.
    int
    getNumBatchThreads()
    Number of scheduling threads for processing batches of work.
    com.google.protobuf.Parser<BatchingOptions>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BatchingOptions.Builder
    newBuilder()
     
    static BatchingOptions.Builder
    newBuilder(BatchingOptions prototype)
     
    BatchingOptions.Builder
    newBuilderForType()
     
    protected BatchingOptions.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BatchingOptions
    parseDelimitedFrom(InputStream input)
     
    static BatchingOptions
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BatchingOptions
    parseFrom(byte[] data)
     
    static BatchingOptions
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BatchingOptions
    parseFrom(com.google.protobuf.ByteString data)
     
    static BatchingOptions
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BatchingOptions
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BatchingOptions
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BatchingOptions
    parseFrom(InputStream input)
     
    static BatchingOptions
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BatchingOptions
    parseFrom(ByteBuffer data)
     
    static BatchingOptions
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BatchingOptions>
    parser()
     
    BatchingOptions.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NUM_BATCH_THREADS_FIELD_NUMBER

      public static final int NUM_BATCH_THREADS_FIELD_NUMBER
      See Also:

    • MAX_BATCH_SIZE_FIELD_NUMBER

      public static final int MAX_BATCH_SIZE_FIELD_NUMBER
      See Also:

    • BATCH_TIMEOUT_MICROS_FIELD_NUMBER

      public static final int BATCH_TIMEOUT_MICROS_FIELD_NUMBER
      See Also:

    • ALLOWED_BATCH_SIZES_FIELD_NUMBER

      public static final int ALLOWED_BATCH_SIZES_FIELD_NUMBER
      See Also:

    • MAX_ENQUEUED_BATCHES_FIELD_NUMBER

      public static final int MAX_ENQUEUED_BATCHES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getNumBatchThreads

      public int getNumBatchThreads()
       Number of scheduling threads for processing batches of work. Determines
 the number of batches processed in parallel. This should be roughly in line
 with the number of TPU cores available.
      int32 num_batch_threads = 1;
      Specified by:
      getNumBatchThreads in interface BatchingOptionsOrBuilder
      Returns:
      The numBatchThreads.

    • getMaxBatchSize

      public int getMaxBatchSize()
       The maximum allowed batch size. Can be larger than allowed_batch_sizes to
 utilize large batch splitting.
      int32 max_batch_size = 2;
      Specified by:
      getMaxBatchSize in interface BatchingOptionsOrBuilder
      Returns:
      The maxBatchSize.

    • getBatchTimeoutMicros

      public int getBatchTimeoutMicros()
       Maximum number of microseconds to wait before outputting an incomplete
 batch.
      int32 batch_timeout_micros = 3;
      Specified by:
      getBatchTimeoutMicros in interface BatchingOptionsOrBuilder
      Returns:
      The batchTimeoutMicros.

    • getAllowedBatchSizesList

      public List<Integer> getAllowedBatchSizesList()
       Optional list of allowed batch sizes. If left empty, does nothing.
 Otherwise, supplies a list of batch sizes, causing the op to pad batches up
 to one of those sizes. The entries must increase monotonically, and the
 final entry must be equal or less than the max_batch_size.
      repeated int32 allowed_batch_sizes = 4;
      Specified by:
      getAllowedBatchSizesList in interface BatchingOptionsOrBuilder
      Returns:
      A list containing the allowedBatchSizes.

    • getAllowedBatchSizesCount

      public int getAllowedBatchSizesCount()
       Optional list of allowed batch sizes. If left empty, does nothing.
 Otherwise, supplies a list of batch sizes, causing the op to pad batches up
 to one of those sizes. The entries must increase monotonically, and the
 final entry must be equal or less than the max_batch_size.
      repeated int32 allowed_batch_sizes = 4;
      Specified by:
      getAllowedBatchSizesCount in interface BatchingOptionsOrBuilder
      Returns:
      The count of allowedBatchSizes.

    • getAllowedBatchSizes

      public int getAllowedBatchSizes(int index)
       Optional list of allowed batch sizes. If left empty, does nothing.
 Otherwise, supplies a list of batch sizes, causing the op to pad batches up
 to one of those sizes. The entries must increase monotonically, and the
 final entry must be equal or less than the max_batch_size.
      repeated int32 allowed_batch_sizes = 4;
      Specified by:
      getAllowedBatchSizes in interface BatchingOptionsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedBatchSizes at the given index.

    • getMaxEnqueuedBatches

      public int getMaxEnqueuedBatches()
       Maximum number of batches enqueued for processing before requests are
 failed fast.
      int32 max_enqueued_batches = 5;
      Specified by:
      getMaxEnqueuedBatches in interface BatchingOptionsOrBuilder
      Returns:
      The maxEnqueuedBatches.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 BatchingOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchingOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchingOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BatchingOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchingOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchingOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchingOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchingOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchingOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static BatchingOptions.Builder newBuilder()

    • newBuilder

      public static BatchingOptions.Builder newBuilder(BatchingOptions prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BatchingOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchingOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchingOptions> 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 BatchingOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder