Package org.platanios.tensorflow.proto

Enum 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 org.platanios.tensorflow.proto.VariableAggregation

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

    • 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.
        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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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 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)
        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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null