Enum VariableAggregation

java.lang.Object
java.lang.Enum<VariableAggregation>
org.tensorflow.proto.VariableAggregation
All Implemented Interfaces:
Internal.EnumLite, ProtocolMessageEnum, Serializable, Comparable<VariableAggregation>
public enum VariableAggregation extends Enum<VariableAggregation> implements ProtocolMessageEnum
Indicates how a distributed variable will be aggregated.
Protobuf enum tensorflow.VariableAggregation

  • Enum Constant Details

    • 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 Details

    • 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:

    • VARIABLE_AGGREGATION_SUM_VALUE

      public static final int VARIABLE_AGGREGATION_SUM_VALUE
      `SUM`: Add the updates across replicas.
      VARIABLE_AGGREGATION_SUM = 1;
      See Also:

    • 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:

    • 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:

  • Method Details

    • values

      public static VariableAggregation[] 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 VariableAggregation 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 VariableAggregation 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 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 Internal.EnumLiteMap<VariableAggregation> 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 VariableAggregation 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