Class BatchingOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

org.tensorflow.proto.BatchingOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, BatchingOptionsOrBuilder

@Generated
public final class BatchingOptions
extends GeneratedMessage
implements BatchingOptionsOrBuilder

Protobuf type tensorflow.BatchingOptions

See Also:

• Serialized Form

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 GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, GeneratedMessage.ExtendableMessage<MessageT>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT, T>, GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class AbstractMessageLite

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 GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class 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 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.
Parser<BatchingOptions>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static BatchingOptions.Builder	newBuilder()
static BatchingOptions.Builder	newBuilder(BatchingOptions prototype)
BatchingOptions.Builder	newBuilderForType()
protected BatchingOptions.Builder	newBuilderForType(AbstractMessage.BuilderParent parent)
static BatchingOptions	parseDelimitedFrom(InputStream input)
static BatchingOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static BatchingOptions	parseFrom(byte[] data)
static BatchingOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static BatchingOptions	parseFrom(ByteString data)
static BatchingOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static BatchingOptions	parseFrom(CodedInputStream input)
static BatchingOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static BatchingOptions	parseFrom(InputStream input)
static BatchingOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static BatchingOptions	parseFrom(ByteBuffer data)
static BatchingOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<BatchingOptions>	parser()
BatchingOptions.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NUM_BATCH_THREADS_FIELD_NUMBER

public static final int NUM_BATCH_THREADS_FIELD_NUMBER

See Also:

• Constant Field Values

MAX_BATCH_SIZE_FIELD_NUMBER

public static final int MAX_BATCH_SIZE_FIELD_NUMBER

See Also:

• Constant Field Values

BATCH_TIMEOUT_MICROS_FIELD_NUMBER

public static final int BATCH_TIMEOUT_MICROS_FIELD_NUMBER

See Also:

• Constant Field Values

ALLOWED_BATCH_SIZES_FIELD_NUMBER

public static final int ALLOWED_BATCH_SIZES_FIELD_NUMBER

See Also:

• Constant Field Values

MAX_ENQUEUED_BATCHES_FIELD_NUMBER

public static final int MAX_ENQUEUED_BATCHES_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage

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 MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static BatchingOptions parseFrom(ByteBuffer data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(byte[] data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BatchingOptions parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static BatchingOptions parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchingOptions parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchingOptions parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static BatchingOptions parseFrom(CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static BatchingOptions parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public BatchingOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface 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 Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected BatchingOptions.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class AbstractMessage

getDefaultInstance

public static BatchingOptions getDefaultInstance()

parser

public static Parser<BatchingOptions> parser()

getParserForType

public Parser<BatchingOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public BatchingOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder