org.tensorflow.framework.VariableAggregation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto Show documentation
Java API for TensorFlow protocol buffers.
There is a newer version: 1.15.0
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: tensorflow/core/framework/variable.proto

package org.tensorflow.framework;

/**
 *  * Indicates how a distributed variable will be aggregated.
 * 
 *
 * Protobuf enum {@code tensorflow.VariableAggregation}
 */
public enum VariableAggregation
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   *    * `NONE`: This is the default, giving an error if you use a
   * variable-update operation with multiple replicas.
   * 
   *
   * VARIABLE_AGGREGATION_NONE = 0;
   */
  VARIABLE_AGGREGATION_NONE(0),
  /**
   *    * `SUM`: Add the updates across replicas.
   * 
   *
   * VARIABLE_AGGREGATION_SUM = 1;
   */
  VARIABLE_AGGREGATION_SUM(1),
  /**
   *    * `MEAN`: Take the arithmetic mean ("average") of the updates across
   * replicas.
   * 
   *
   * VARIABLE_AGGREGATION_MEAN = 2;
   */
  VARIABLE_AGGREGATION_MEAN(2),
  /**
   *    * `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;
   */
  VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA(3),
  UNRECOGNIZED(-1),
  ;

  /**
   *    * `NONE`: This is the default, giving an error if you use a
   * variable-update operation with multiple replicas.
   * 
   *
   * VARIABLE_AGGREGATION_NONE = 0;
   */
  public static final int VARIABLE_AGGREGATION_NONE_VALUE = 0;
  /**
   *    * `SUM`: Add the updates across replicas.
   * 
   *
   * VARIABLE_AGGREGATION_SUM = 1;
   */
  public static final int VARIABLE_AGGREGATION_SUM_VALUE = 1;
  /**
   *    * `MEAN`: Take the arithmetic mean ("average") of the updates across
   * replicas.
   * 
   *
   * VARIABLE_AGGREGATION_MEAN = 2;
   */
  public static final int VARIABLE_AGGREGATION_MEAN_VALUE = 2;
  /**
   *    * `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;
   */
  public static final int VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA_VALUE = 3;


  public final int getNumber() {
    if (this == UNRECOGNIZED) {
      throw new java.lang.IllegalArgumentException(
          "Can't get the number of an unknown enum value.");
    }
    return value;
  }

  /**
   * @deprecated Use {@link #forNumber(int)} instead.
   */
  @java.lang.Deprecated
  public static VariableAggregation valueOf(int value) {
    return forNumber(value);
  }

  public static VariableAggregation forNumber(int value) {
    switch (value) {
      case 0: return VARIABLE_AGGREGATION_NONE;
      case 1: return VARIABLE_AGGREGATION_SUM;
      case 2: return VARIABLE_AGGREGATION_MEAN;
      case 3: return VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      VariableAggregation> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public VariableAggregation findValueByNumber(int number) {
            return VariableAggregation.forNumber(number);
          }
        };

  public final com.google.protobuf.Descriptors.EnumValueDescriptor
      getValueDescriptor() {
    return getDescriptor().getValues().get(ordinal());
  }
  public final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptorForType() {
    return getDescriptor();
  }
  public static final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptor() {
    return org.tensorflow.framework.VariableProtos.getDescriptor().getEnumTypes().get(1);
  }

  private static final VariableAggregation[] VALUES = values();

  public static VariableAggregation valueOf(
      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
    if (desc.getType() != getDescriptor()) {
      throw new java.lang.IllegalArgumentException(
        "EnumValueDescriptor is not for this type.");
    }
    if (desc.getIndex() == -1) {
      return UNRECOGNIZED;
    }
    return VALUES[desc.getIndex()];
  }

  private final int value;

  private VariableAggregation(int value) {
    this.value = value;
  }

  // @@protoc_insertion_point(enum_scope:tensorflow.VariableAggregation)
}