org.tensorflow.framework

Enum VariableAggregation

java.lang.Object

java.lang.Enum<VariableAggregation>

org.tensorflow.framework.VariableAggregation

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<VariableAggregation>

public enum VariableAggregation
extends java.lang.Enum<VariableAggregation>
implements com.google.protobuf.ProtocolMessageEnum

 Indicates how a distributed variable will be aggregated.
 

Protobuf enum tensorflow.VariableAggregation

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNRECOGNIZED
VARIABLE_AGGREGATION_MEAN `MEAN`: Take the arithmetic mean ("average") of the updates across replicas.
VARIABLE_AGGREGATION_NONE `NONE`: This is the default, giving an error if you use a variable-update operation with multiple replicas.
VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA `ONLY_FIRST_REPLICA`: This is for when every replica is performing the same update, but we only want to perform the update once.
VARIABLE_AGGREGATION_SUM `SUM`: Add the updates across replicas.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VARIABLE_AGGREGATION_MEAN_VALUE `MEAN`: Take the arithmetic mean ("average") of the updates across replicas.
static int	VARIABLE_AGGREGATION_NONE_VALUE `NONE`: This is the default, giving an error if you use a variable-update operation with multiple replicas.
static int	VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA_VALUE `ONLY_FIRST_REPLICA`: This is for when every replica is performing the same update, but we only want to perform the update once.
static int	VARIABLE_AGGREGATION_SUM_VALUE `SUM`: Add the updates across replicas.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VARIABLE_AGGREGATION_NONE

public static final VariableAggregation VARIABLE_AGGREGATION_NONE

 `NONE`: This is the default, giving an error if you use a
 variable-update operation with multiple replicas.
 

VARIABLE_AGGREGATION_NONE = 0;

VARIABLE_AGGREGATION_SUM

public static final VariableAggregation VARIABLE_AGGREGATION_SUM

 `SUM`: Add the updates across replicas.
 

VARIABLE_AGGREGATION_SUM = 1;

VARIABLE_AGGREGATION_MEAN

public static final VariableAggregation VARIABLE_AGGREGATION_MEAN

 `MEAN`: Take the arithmetic mean ("average") of the updates across
 replicas.
 

VARIABLE_AGGREGATION_MEAN = 2;

VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA

public static final VariableAggregation VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA

 `ONLY_FIRST_REPLICA`: This is for when every replica is performing the same
 update, but we only want to perform the update once. Used, e.g., for the
 global step counter.
 

VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA = 3;

UNRECOGNIZED

public static final VariableAggregation UNRECOGNIZED

Field Detail

VARIABLE_AGGREGATION_NONE_VALUE

public static final int VARIABLE_AGGREGATION_NONE_VALUE

 `NONE`: This is the default, giving an error if you use a
 variable-update operation with multiple replicas.
 

VARIABLE_AGGREGATION_NONE = 0;

See Also:

Constant Field Values

VARIABLE_AGGREGATION_SUM_VALUE

public static final int VARIABLE_AGGREGATION_SUM_VALUE

 `SUM`: Add the updates across replicas.
 

VARIABLE_AGGREGATION_SUM = 1;

See Also:

Constant Field Values

VARIABLE_AGGREGATION_MEAN_VALUE

public static final int VARIABLE_AGGREGATION_MEAN_VALUE

 `MEAN`: Take the arithmetic mean ("average") of the updates across
 replicas.
 

VARIABLE_AGGREGATION_MEAN = 2;

See Also:

Constant Field Values

VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA_VALUE

public static final int VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA_VALUE

 `ONLY_FIRST_REPLICA`: This is for when every replica is performing the same
 update, but we only want to perform the update once. Used, e.g., for the
 global step counter.
 

VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA = 3;

See Also:

Constant Field Values

Method Detail

values

public static VariableAggregation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VariableAggregation c : VariableAggregation.values())
    System.out.println(c);

Returns:

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

valueOf

public static VariableAggregation valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static VariableAggregation valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

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

Returns:

The enum associated with the given numeric wire value.

forNumber

public static VariableAggregation 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 com.google.protobuf.Internal.EnumLiteMap<VariableAggregation> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static VariableAggregation valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)