Enum DatasetOptions.AutoShardPolicy

java.lang.Object

java.lang.Enum<DatasetOptions.AutoShardPolicy>

org.tensorflow.proto.data.DatasetOptions.AutoShardPolicy

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, Serializable, Comparable<DatasetOptions.AutoShardPolicy>

Enclosing class:

DatasetOptions

public static enum DatasetOptions.AutoShardPolicy
extends Enum<DatasetOptions.AutoShardPolicy>
implements ProtocolMessageEnum

Represents the type of auto-sharding we enable.

Protobuf enum tensorflow.data.AutoShardPolicy

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	AUTO: Attempts FILE-based sharding, falling back to DATA-based sharding.
DATA	DATA: Shards by elements produced by the dataset.
FILE	FILE: Shards by input files (i.e. each worker will get a set of files to process).
HINT	HINT: Looks for the presence of `shard(SHARD_HINT, ...)` which is treated as a placeholder to replace with `shard(num_workers, worker_index)`.
OFF	OFF: No sharding will be performed.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTO_VALUE	AUTO: Attempts FILE-based sharding, falling back to DATA-based sharding.
static final int	DATA_VALUE	DATA: Shards by elements produced by the dataset.
static final int	FILE_VALUE	FILE: Shards by input files (i.e. each worker will get a set of files to process).
static final int	HINT_VALUE	HINT: Looks for the presence of `shard(SHARD_HINT, ...)` which is treated as a placeholder to replace with `shard(num_workers, worker_index)`.
static final int	OFF_VALUE	OFF: No sharding will be performed.

Method Summary

Modifier and Type	Method	Description
static DatasetOptions.AutoShardPolicy	forNumber(int value)
static final Descriptors.EnumDescriptor	getDescriptor()
final Descriptors.EnumDescriptor	getDescriptorForType()
final int	getNumber()
final Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<DatasetOptions.AutoShardPolicy>	internalGetValueMap()
static DatasetOptions.AutoShardPolicy	valueOf(int value)	Deprecated.
static DatasetOptions.AutoShardPolicy	valueOf(Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static DatasetOptions.AutoShardPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DatasetOptions.AutoShardPolicy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final DatasetOptions.AutoShardPolicy AUTO

AUTO: Attempts FILE-based sharding, falling back to DATA-based sharding.

AUTO = 0;

FILE

public static final DatasetOptions.AutoShardPolicy FILE

FILE: Shards by input files (i.e. each worker will get a set of files to
process). When this option is selected, make sure that there is at least as
many files as workers. If there are fewer input files than workers, a
runtime error will be raised.

FILE = 1;

DATA

public static final DatasetOptions.AutoShardPolicy DATA

DATA: Shards by elements produced by the dataset. Each worker will process
the whole dataset and discard the portion that is not for itself. Note that
for this mode to correctly partitions the dataset elements, the dataset
needs to produce elements in a deterministic order.

DATA = 2;

HINT

public static final DatasetOptions.AutoShardPolicy HINT

HINT: Looks for the presence of `shard(SHARD_HINT, ...)` which is treated
as a placeholder to replace with `shard(num_workers, worker_index)`.

HINT = 3;

OFF

public static final DatasetOptions.AutoShardPolicy OFF

OFF: No sharding will be performed.

OFF = -1;

UNRECOGNIZED

public static final DatasetOptions.AutoShardPolicy UNRECOGNIZED

Field Details

AUTO_VALUE

public static final int AUTO_VALUE

AUTO: Attempts FILE-based sharding, falling back to DATA-based sharding.

AUTO = 0;

See Also:

• Constant Field Values

FILE_VALUE

public static final int FILE_VALUE

FILE: Shards by input files (i.e. each worker will get a set of files to
process). When this option is selected, make sure that there is at least as
many files as workers. If there are fewer input files than workers, a
runtime error will be raised.

FILE = 1;

See Also:

• Constant Field Values

DATA_VALUE

public static final int DATA_VALUE

DATA: Shards by elements produced by the dataset. Each worker will process
the whole dataset and discard the portion that is not for itself. Note that
for this mode to correctly partitions the dataset elements, the dataset
needs to produce elements in a deterministic order.

DATA = 2;

See Also:

• Constant Field Values

HINT_VALUE

public static final int HINT_VALUE

HINT: Looks for the presence of `shard(SHARD_HINT, ...)` which is treated
as a placeholder to replace with `shard(num_workers, worker_index)`.

HINT = 3;

See Also:

• Constant Field Values

OFF_VALUE

public static final int OFF_VALUE

OFF: No sharding will be performed.

OFF = -1;

See Also:

• Constant Field Values

Method Details

values

public static DatasetOptions.AutoShardPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DatasetOptions.AutoShardPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static DatasetOptions.AutoShardPolicy valueOf(int value)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forNumber

public static DatasetOptions.AutoShardPolicy forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static Internal.EnumLiteMap<DatasetOptions.AutoShardPolicy> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static DatasetOptions.AutoShardPolicy valueOf(Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

desc - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null