Class ServiceConfig.WorkerConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.data.experimental.ServiceConfig.WorkerConfig

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, ServiceConfig.WorkerConfigOrBuilder

Enclosing class:

ServiceConfig

public static final class ServiceConfig.WorkerConfig
extends GeneratedMessageV3
implements ServiceConfig.WorkerConfigOrBuilder

Configuration for a tf.data service WorkerServer.
Next id: 14

Protobuf type tensorflow.data.experimental.WorkerConfig

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServiceConfig.WorkerConfig.Builder	Configuration for a tf.data service WorkerServer.

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	CROSS_TRAINER_CACHE_SIZE_BYTES_FIELD_NUMBER
static final int	DATA_TRANSFER_ADDRESS_FIELD_NUMBER
static final int	DATA_TRANSFER_PORT_FIELD_NUMBER
static final int	DATA_TRANSFER_PROTOCOL_FIELD_NUMBER
static final int	DISPATCHER_ADDRESS_FIELD_NUMBER
static final int	DISPATCHER_TIMEOUT_MS_FIELD_NUMBER
static final int	HEARTBEAT_INTERVAL_MS_FIELD_NUMBER
static final int	PORT_FIELD_NUMBER
static final int	PROTOCOL_FIELD_NUMBER
static final int	SHUTDOWN_QUIET_PERIOD_MS_FIELD_NUMBER
static final int	SNAPSHOT_MAX_CHUNK_SIZE_BYTES_FIELD_NUMBER
static final int	WORKER_ADDRESS_FIELD_NUMBER
static final int	WORKER_TAGS_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)
long	getCrossTrainerCacheSizeBytes()	Maximum size of the cross-trainer cache in bytes.
String	getDataTransferAddress()	If `data_transfer_protocol` is set, the address of the data transfer server.
ByteString	getDataTransferAddressBytes()	If `data_transfer_protocol` is set, the address of the data transfer server.
long	getDataTransferPort()	If `data_transfer_protocol` is set, the port to which the data transfer server binds.
String	getDataTransferProtocol()	If set, the name of an alternative data transfer protocol for which the worker starts an additional server ("data transfer server"); the trainer can then get data from this server.
ByteString	getDataTransferProtocolBytes()	If set, the name of an alternative data transfer protocol for which the worker starts an additional server ("data transfer server"); the trainer can then get data from this server.
static ServiceConfig.WorkerConfig	getDefaultInstance()
ServiceConfig.WorkerConfig	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
String	getDispatcherAddress()	The address of the dispatcher to register with.
ByteString	getDispatcherAddressBytes()	The address of the dispatcher to register with.
long	getDispatcherTimeoutMs()	How long to retry requests to the dispatcher before giving up and reporting an error.
long	getHeartbeatIntervalMs()	How often the worker should heartbeat to the master.
Parser<ServiceConfig.WorkerConfig>	getParserForType()
long	getPort()	The port for the worker to bind to.
String	getProtocol()	The protocol for the worker to use when connecting to the dispatcher.
ByteString	getProtocolBytes()	The protocol for the worker to use when connecting to the dispatcher.
int	getSerializedSize()
long	getShutdownQuietPeriodMs()	When shutting down a worker, how long to wait for the gRPC server to process the final requests.
long	getSnapshotMaxChunkSizeBytes()	The maximum size of a distributed snapshot chunk file.
final UnknownFieldSet	getUnknownFields()
String	getWorkerAddress()	The address of the worker server.
ByteString	getWorkerAddressBytes()	The address of the worker server.
String	getWorkerTags(int index)	Tags attached to the worker.
ByteString	getWorkerTagsBytes(int index)	Tags attached to the worker.
int	getWorkerTagsCount()	Tags attached to the worker.
ProtocolStringList	getWorkerTagsList()	Tags attached to the worker.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ServiceConfig.WorkerConfig.Builder	newBuilder()
static ServiceConfig.WorkerConfig.Builder	newBuilder(ServiceConfig.WorkerConfig prototype)
ServiceConfig.WorkerConfig.Builder	newBuilderForType()
protected ServiceConfig.WorkerConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ServiceConfig.WorkerConfig	parseDelimitedFrom(InputStream input)
static ServiceConfig.WorkerConfig	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.WorkerConfig	parseFrom(byte[] data)
static ServiceConfig.WorkerConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.WorkerConfig	parseFrom(ByteString data)
static ServiceConfig.WorkerConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.WorkerConfig	parseFrom(CodedInputStream input)
static ServiceConfig.WorkerConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.WorkerConfig	parseFrom(InputStream input)
static ServiceConfig.WorkerConfig	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.WorkerConfig	parseFrom(ByteBuffer data)
static ServiceConfig.WorkerConfig	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<ServiceConfig.WorkerConfig>	parser()
ServiceConfig.WorkerConfig.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

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER

See Also:

• Constant Field Values

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER

See Also:

• Constant Field Values

DISPATCHER_ADDRESS_FIELD_NUMBER

public static final int DISPATCHER_ADDRESS_FIELD_NUMBER

See Also:

• Constant Field Values

WORKER_ADDRESS_FIELD_NUMBER

public static final int WORKER_ADDRESS_FIELD_NUMBER

See Also:

• Constant Field Values

WORKER_TAGS_FIELD_NUMBER

public static final int WORKER_TAGS_FIELD_NUMBER

See Also:

• Constant Field Values

HEARTBEAT_INTERVAL_MS_FIELD_NUMBER

public static final int HEARTBEAT_INTERVAL_MS_FIELD_NUMBER

See Also:

• Constant Field Values

DISPATCHER_TIMEOUT_MS_FIELD_NUMBER

public static final int DISPATCHER_TIMEOUT_MS_FIELD_NUMBER

See Also:

• Constant Field Values

DATA_TRANSFER_PROTOCOL_FIELD_NUMBER

public static final int DATA_TRANSFER_PROTOCOL_FIELD_NUMBER

See Also:

• Constant Field Values

DATA_TRANSFER_PORT_FIELD_NUMBER

public static final int DATA_TRANSFER_PORT_FIELD_NUMBER

See Also:

• Constant Field Values

DATA_TRANSFER_ADDRESS_FIELD_NUMBER

public static final int DATA_TRANSFER_ADDRESS_FIELD_NUMBER

See Also:

• Constant Field Values

CROSS_TRAINER_CACHE_SIZE_BYTES_FIELD_NUMBER

public static final int CROSS_TRAINER_CACHE_SIZE_BYTES_FIELD_NUMBER

See Also:

• Constant Field Values

SNAPSHOT_MAX_CHUNK_SIZE_BYTES_FIELD_NUMBER

public static final int SNAPSHOT_MAX_CHUNK_SIZE_BYTES_FIELD_NUMBER

See Also:

• Constant Field Values

SHUTDOWN_QUIET_PERIOD_MS_FIELD_NUMBER

public static final int SHUTDOWN_QUIET_PERIOD_MS_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

getPort

public long getPort()

The port for the worker to bind to. A value of 0 indicates that the
worker may bind to any available port.

int64 port = 1;

Specified by:

getPort in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The port.

getProtocol

public String getProtocol()

The protocol for the worker to use when connecting to the dispatcher.

string protocol = 2;

Specified by:

getProtocol in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The protocol.

getProtocolBytes

public ByteString getProtocolBytes()

The protocol for the worker to use when connecting to the dispatcher.

string protocol = 2;

Specified by:

getProtocolBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The bytes for protocol.

getDispatcherAddress

public String getDispatcherAddress()

The address of the dispatcher to register with.

string dispatcher_address = 3;

Specified by:

getDispatcherAddress in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The dispatcherAddress.

getDispatcherAddressBytes

public ByteString getDispatcherAddressBytes()

The address of the dispatcher to register with.

string dispatcher_address = 3;

Specified by:

getDispatcherAddressBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The bytes for dispatcherAddress.

getWorkerAddress

public String getWorkerAddress()

The address of the worker server. The substring "%port%", if specified,
will be replaced with the worker's bound port. This is useful when the port
is set to `0`.

string worker_address = 4;

Specified by:

getWorkerAddress in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The workerAddress.

getWorkerAddressBytes

public ByteString getWorkerAddressBytes()

The address of the worker server. The substring "%port%", if specified,
will be replaced with the worker's bound port. This is useful when the port
is set to `0`.

string worker_address = 4;

Specified by:

getWorkerAddressBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The bytes for workerAddress.

getWorkerTagsList

public ProtocolStringList getWorkerTagsList()

Tags attached to the worker. This allows reading from selected workers.
For example, by applying a "COLOCATED" tag, tf.data service is able to read
from the local tf.data worker if one exists, then from off-TF-host workers,
to avoid cross-TF-host reads.

repeated string worker_tags = 10;

Specified by:

getWorkerTagsList in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

A list containing the workerTags.

getWorkerTagsCount

public int getWorkerTagsCount()

Tags attached to the worker. This allows reading from selected workers.
For example, by applying a "COLOCATED" tag, tf.data service is able to read
from the local tf.data worker if one exists, then from off-TF-host workers,
to avoid cross-TF-host reads.

repeated string worker_tags = 10;

Specified by:

getWorkerTagsCount in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The count of workerTags.

getWorkerTags

public String getWorkerTags(int index)

Tags attached to the worker. This allows reading from selected workers.
For example, by applying a "COLOCATED" tag, tf.data service is able to read
from the local tf.data worker if one exists, then from off-TF-host workers,
to avoid cross-TF-host reads.

repeated string worker_tags = 10;

Specified by:

getWorkerTags in interface ServiceConfig.WorkerConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The workerTags at the given index.

getWorkerTagsBytes

public ByteString getWorkerTagsBytes(int index)

Tags attached to the worker. This allows reading from selected workers.
For example, by applying a "COLOCATED" tag, tf.data service is able to read
from the local tf.data worker if one exists, then from off-TF-host workers,
to avoid cross-TF-host reads.

repeated string worker_tags = 10;

Specified by:

getWorkerTagsBytes in interface ServiceConfig.WorkerConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the workerTags at the given index.

getHeartbeatIntervalMs

public long getHeartbeatIntervalMs()

How often the worker should heartbeat to the master. A value of 0 indicates
that the decision should be left up to the runtime.

int64 heartbeat_interval_ms = 5;

Specified by:

getHeartbeatIntervalMs in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The heartbeatIntervalMs.

getDispatcherTimeoutMs

public long getDispatcherTimeoutMs()

How long to retry requests to the dispatcher before giving up and reporting
an error. A value of 0 indicates that the decision should be left up to the
runtime.

int64 dispatcher_timeout_ms = 6;

Specified by:

getDispatcherTimeoutMs in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The dispatcherTimeoutMs.

getDataTransferProtocol

public String getDataTransferProtocol()

If set, the name of an alternative data transfer protocol for which the
worker starts an additional server ("data transfer server"); the trainer
can then get data from this server. If not set, no such server is started,
and the trainer can only get data from the regular worker server over
`protocol`.

string data_transfer_protocol = 7;

Specified by:

getDataTransferProtocol in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The dataTransferProtocol.

getDataTransferProtocolBytes

public ByteString getDataTransferProtocolBytes()

If set, the name of an alternative data transfer protocol for which the
worker starts an additional server ("data transfer server"); the trainer
can then get data from this server. If not set, no such server is started,
and the trainer can only get data from the regular worker server over
`protocol`.

string data_transfer_protocol = 7;

Specified by:

getDataTransferProtocolBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The bytes for dataTransferProtocol.

getDataTransferPort

public long getDataTransferPort()

If `data_transfer_protocol` is set, the port to which the data transfer
server binds. If set to `0`, the server binds to any available port.

int64 data_transfer_port = 13;

Specified by:

getDataTransferPort in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The dataTransferPort.

getDataTransferAddress

public String getDataTransferAddress()

If `data_transfer_protocol` is set, the address of the data transfer
server. The substring "%dts_port%" can be used to represent -- and is
replaced with -- the bound port of the data transfer server; this is useful
when `data_transfer_port` is set to `0`.

string data_transfer_address = 8;

Specified by:

getDataTransferAddress in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The dataTransferAddress.

getDataTransferAddressBytes

public ByteString getDataTransferAddressBytes()

If `data_transfer_protocol` is set, the address of the data transfer
server. The substring "%dts_port%" can be used to represent -- and is
replaced with -- the bound port of the data transfer server; this is useful
when `data_transfer_port` is set to `0`.

string data_transfer_address = 8;

Specified by:

getDataTransferAddressBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The bytes for dataTransferAddress.

getCrossTrainerCacheSizeBytes

public long getCrossTrainerCacheSizeBytes()

Maximum size of the cross-trainer cache in bytes. If enabled, make sure
your training job provides sufficient memory resources.

int64 cross_trainer_cache_size_bytes = 11;

Specified by:

getCrossTrainerCacheSizeBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The crossTrainerCacheSizeBytes.

getSnapshotMaxChunkSizeBytes

public long getSnapshotMaxChunkSizeBytes()

The maximum size of a distributed snapshot chunk file. A value of 0
indicates that the decision should be left up to the runtime.

int64 snapshot_max_chunk_size_bytes = 12;

Specified by:

getSnapshotMaxChunkSizeBytes in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The snapshotMaxChunkSizeBytes.

getShutdownQuietPeriodMs

public long getShutdownQuietPeriodMs()

When shutting down a worker, how long to wait for the gRPC server to
process the final requests. This is used to achieve clean shutdown in unit
tests.

int64 shutdown_quiet_period_ms = 9;

Specified by:

getShutdownQuietPeriodMs in interface ServiceConfig.WorkerConfigOrBuilder

Returns:

The shutdownQuietPeriodMs.

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

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(ByteString data)
                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(byte[] data)
                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.WorkerConfig parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.WorkerConfig parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.WorkerConfig parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public ServiceConfig.WorkerConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ServiceConfig.WorkerConfig.Builder newBuilder()

newBuilder

public static ServiceConfig.WorkerConfig.Builder newBuilder(ServiceConfig.WorkerConfig prototype)

toBuilder

public ServiceConfig.WorkerConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ServiceConfig.WorkerConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ServiceConfig.WorkerConfig getDefaultInstance()

parser

public static Parser<ServiceConfig.WorkerConfig> parser()

getParserForType

public Parser<ServiceConfig.WorkerConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ServiceConfig.WorkerConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder