Class RpcOptions.RPCOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.RpcOptions.RPCOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, RpcOptions.RPCOptionsOrBuilder

Enclosing class:

RpcOptions

public static final class RpcOptions.RPCOptions
extends GeneratedMessageV3
implements RpcOptions.RPCOptionsOrBuilder

RPC options for distributed runtime.

Protobuf type tensorflow.RPCOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RpcOptions.RPCOptions.Builder	RPC options for distributed runtime.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CACHE_RPC_RESPONSE_FIELD_NUMBER
static final int	COMPRESSION_ALGORITHM_FIELD_NUMBER
static final int	COMPRESSION_LEVEL_FIELD_NUMBER
static final int	DISABLE_SESSION_CONNECTION_SHARING_FIELD_NUMBER
static final int	NUM_CHANNELS_PER_TARGET_FIELD_NUMBER
static final int	USE_RPC_FOR_INPROCESS_MASTER_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

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)
boolean	getCacheRpcResponse()	Setting cache_rpc_response to true will enable sender side caching of response for RecvTensorAsync and RecvBufAsync to allow receiver to retry requests .
String	getCompressionAlgorithm()	The compression algorithm to be used.
ByteString	getCompressionAlgorithmBytes()	The compression algorithm to be used.
int	getCompressionLevel()	If compression_algorithm is set, the compression level to be used.
static RpcOptions.RPCOptions	getDefaultInstance()
RpcOptions.RPCOptions	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
boolean	getDisableSessionConnectionSharing()	Disables TCP connection sharing when opening a new RPC channel.
int	getNumChannelsPerTarget()	Setting num_channels_per_target > 0 allows uses of multiple channels to communicate to the same target.
Parser<RpcOptions.RPCOptions>	getParserForType()
int	getSerializedSize()
final UnknownFieldSet	getUnknownFields()
boolean	getUseRpcForInprocessMaster()	If true, always use RPC to contact the session target.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RpcOptions.RPCOptions.Builder	newBuilder()
static RpcOptions.RPCOptions.Builder	newBuilder(RpcOptions.RPCOptions prototype)
RpcOptions.RPCOptions.Builder	newBuilderForType()
protected RpcOptions.RPCOptions.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static RpcOptions.RPCOptions	parseDelimitedFrom(InputStream input)
static RpcOptions.RPCOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RpcOptions.RPCOptions	parseFrom(byte[] data)
static RpcOptions.RPCOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RpcOptions.RPCOptions	parseFrom(ByteString data)
static RpcOptions.RPCOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RpcOptions.RPCOptions	parseFrom(CodedInputStream input)
static RpcOptions.RPCOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RpcOptions.RPCOptions	parseFrom(InputStream input)
static RpcOptions.RPCOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RpcOptions.RPCOptions	parseFrom(ByteBuffer data)
static RpcOptions.RPCOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<RpcOptions.RPCOptions>	parser()
RpcOptions.RPCOptions.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

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

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

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

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

USE_RPC_FOR_INPROCESS_MASTER_FIELD_NUMBER

public static final int USE_RPC_FOR_INPROCESS_MASTER_FIELD_NUMBER

See Also:

• Constant Field Values

COMPRESSION_ALGORITHM_FIELD_NUMBER

public static final int COMPRESSION_ALGORITHM_FIELD_NUMBER

See Also:

• Constant Field Values

COMPRESSION_LEVEL_FIELD_NUMBER

public static final int COMPRESSION_LEVEL_FIELD_NUMBER

See Also:

• Constant Field Values

CACHE_RPC_RESPONSE_FIELD_NUMBER

public static final int CACHE_RPC_RESPONSE_FIELD_NUMBER

See Also:

• Constant Field Values

DISABLE_SESSION_CONNECTION_SHARING_FIELD_NUMBER

public static final int DISABLE_SESSION_CONNECTION_SHARING_FIELD_NUMBER

See Also:

• Constant Field Values

NUM_CHANNELS_PER_TARGET_FIELD_NUMBER

public static final int NUM_CHANNELS_PER_TARGET_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getUseRpcForInprocessMaster

public boolean getUseRpcForInprocessMaster()

If true, always use RPC to contact the session target.
If false (the default option), TensorFlow may use an optimized
transport for client-master communication that avoids the RPC
stack. This option is primarily for used testing the RPC stack.

bool use_rpc_for_inprocess_master = 1;

Specified by:

getUseRpcForInprocessMaster in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The useRpcForInprocessMaster.

getCompressionAlgorithm

public String getCompressionAlgorithm()

The compression algorithm to be used. One of "deflate", "gzip".

string compression_algorithm = 2;

Specified by:

getCompressionAlgorithm in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The compressionAlgorithm.

getCompressionAlgorithmBytes

public ByteString getCompressionAlgorithmBytes()

The compression algorithm to be used. One of "deflate", "gzip".

string compression_algorithm = 2;

Specified by:

getCompressionAlgorithmBytes in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The bytes for compressionAlgorithm.

getCompressionLevel

public int getCompressionLevel()

If compression_algorithm is set, the compression level to be used.
From 0 (no compression), up to 3.

int32 compression_level = 3;

Specified by:

getCompressionLevel in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The compressionLevel.

getCacheRpcResponse

public boolean getCacheRpcResponse()

Setting cache_rpc_response to true will enable sender side caching of
response for RecvTensorAsync and RecvBufAsync to allow receiver to retry
requests . This is only necessary when the network fabric is experiencing a
significant error rate.  Without it we'll fail a step on an network error,
while with it we'll be able to complete long steps (like complex
initializations) in the face of some network errors during RecvTensor.

bool cache_rpc_response = 4;

Specified by:

getCacheRpcResponse in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The cacheRpcResponse.

getDisableSessionConnectionSharing

public boolean getDisableSessionConnectionSharing()

Disables TCP connection sharing when opening a new RPC channel.

bool disable_session_connection_sharing = 5;

Specified by:

getDisableSessionConnectionSharing in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The disableSessionConnectionSharing.

getNumChannelsPerTarget

public int getNumChannelsPerTarget()

Setting num_channels_per_target > 0 allows uses of multiple channels to
communicate to the same target. This can be used to improve the aggregate
throughput on high speed links (e.g 100G) where single connection is not
sufficient to maximize link utilization. Note that a single RPC only goes
on a single channel, this only helps in situations where there are multiple
transfers to the same target overlapping in time.

int32 num_channels_per_target = 6;

Specified by:

getNumChannelsPerTarget in interface RpcOptions.RPCOptionsOrBuilder

Returns:

The numChannelsPerTarget.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

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 RpcOptions.RPCOptions parseFrom(ByteBuffer data)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(ByteString data)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(byte[] data)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RpcOptions.RPCOptions parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static RpcOptions.RPCOptions parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static RpcOptions.RPCOptions parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static RpcOptions.RPCOptions parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static RpcOptions.RPCOptions parseFrom(CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static RpcOptions.RPCOptions parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public RpcOptions.RPCOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RpcOptions.RPCOptions.Builder newBuilder()

newBuilder

public static RpcOptions.RPCOptions.Builder newBuilder(RpcOptions.RPCOptions prototype)

toBuilder

public RpcOptions.RPCOptions.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RpcOptions.RPCOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RpcOptions.RPCOptions getDefaultInstance()

parser

public static Parser<RpcOptions.RPCOptions> parser()

getParserForType

public Parser<RpcOptions.RPCOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RpcOptions.RPCOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder