Enum VariableSynchronization

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

  • Enum Constant Details

    • VARIABLE_SYNCHRONIZATION_AUTO

      public static final VariableSynchronization VARIABLE_SYNCHRONIZATION_AUTO
      `AUTO`: Indicates that the synchronization will be determined by the
current `DistributionStrategy` (eg. With `MirroredStrategy` this would be
`ON_WRITE`).
      VARIABLE_SYNCHRONIZATION_AUTO = 0;

    • VARIABLE_SYNCHRONIZATION_NONE

      public static final VariableSynchronization VARIABLE_SYNCHRONIZATION_NONE
      `NONE`: Indicates that there will only be one copy of the variable, so
there is no need to sync.
      VARIABLE_SYNCHRONIZATION_NONE = 1;

    • VARIABLE_SYNCHRONIZATION_ON_WRITE

      public static final VariableSynchronization VARIABLE_SYNCHRONIZATION_ON_WRITE
      `ON_WRITE`: Indicates that the variable will be updated across devices
every time it is written.
      VARIABLE_SYNCHRONIZATION_ON_WRITE = 2;

    • VARIABLE_SYNCHRONIZATION_ON_READ

      public static final VariableSynchronization VARIABLE_SYNCHRONIZATION_ON_READ
      `ON_READ`: Indicates that the variable will be aggregated across devices
when it is read (eg. when checkpointing or when evaluating an op that uses
the variable).
      VARIABLE_SYNCHRONIZATION_ON_READ = 3;

    • UNRECOGNIZED

      public static final VariableSynchronization UNRECOGNIZED

  • Field Details

    • VARIABLE_SYNCHRONIZATION_AUTO_VALUE

      public static final int VARIABLE_SYNCHRONIZATION_AUTO_VALUE
      `AUTO`: Indicates that the synchronization will be determined by the
current `DistributionStrategy` (eg. With `MirroredStrategy` this would be
`ON_WRITE`).
      VARIABLE_SYNCHRONIZATION_AUTO = 0;
      See Also:

    • VARIABLE_SYNCHRONIZATION_NONE_VALUE

      public static final int VARIABLE_SYNCHRONIZATION_NONE_VALUE
      `NONE`: Indicates that there will only be one copy of the variable, so
there is no need to sync.
      VARIABLE_SYNCHRONIZATION_NONE = 1;
      See Also:

    • VARIABLE_SYNCHRONIZATION_ON_WRITE_VALUE

      public static final int VARIABLE_SYNCHRONIZATION_ON_WRITE_VALUE
      `ON_WRITE`: Indicates that the variable will be updated across devices
every time it is written.
      VARIABLE_SYNCHRONIZATION_ON_WRITE = 2;
      See Also:

    • VARIABLE_SYNCHRONIZATION_ON_READ_VALUE

      public static final int VARIABLE_SYNCHRONIZATION_ON_READ_VALUE
      `ON_READ`: Indicates that the variable will be aggregated across devices
when it is read (eg. when checkpointing or when evaluating an op that uses
the variable).
      VARIABLE_SYNCHRONIZATION_ON_READ = 3;
      See Also:

  • Method Details

    • values

      public static VariableSynchronization[] 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 VariableSynchronization 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 VariableSynchronization 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 VariableSynchronization 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<VariableSynchronization> 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 VariableSynchronization 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