Enum VariableSynchronization 

#[repr(i32)]
pub enum VariableSynchronization {
    Auto = 0,
    None = 1,
    OnWrite = 2,
    OnRead = 3,
}

Indicates when a distributed variable will be synced.

Variants

Auto = 0

AUTO: Indicates that the synchronization will be determined by the current DistributionStrategy (eg. With MirroredStrategy this would be ON_WRITE).

None = 1

NONE: Indicates that there will only be one copy of the variable, so there is no need to sync.

OnWrite = 2

ON_WRITE: Indicates that the variable will be updated across devices every time it is written.

OnRead = 3

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).

Implementations

impl VariableSynchronization

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of VariableSynchronization.

pub fn from_i32(value: i32) -> Option<VariableSynchronization>

Converts an i32 to a VariableSynchronization, or None if value is not a valid variant.

impl VariableSynchronization

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

Trait Implementations

impl Clone for VariableSynchronization

fn clone(&self) -> VariableSynchronization

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VariableSynchronization

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VariableSynchronization

fn default() -> VariableSynchronization

Returns the “default value” for a type.

impl From<VariableSynchronization> for i32

fn from(value: VariableSynchronization) -> i32

Converts to this type from the input type.

impl Hash for VariableSynchronization

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VariableSynchronization

fn cmp(&self, other: &VariableSynchronization) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VariableSynchronization

fn eq(&self, other: &VariableSynchronization) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VariableSynchronization

fn partial_cmp(&self, other: &VariableSynchronization) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for VariableSynchronization

impl Eq for VariableSynchronization

impl StructuralPartialEq for VariableSynchronization