Enum VariableAggregation 

#[repr(i32)]
pub enum VariableAggregation {
    None = 0,
    Sum = 1,
    Mean = 2,
    OnlyFirstReplica = 3,
}

Indicates how a distributed variable will be aggregated.

Variants

None = 0

NONE: This is the default, giving an error if you use a variable-update operation with multiple replicas.

Sum = 1

SUM: Add the updates across replicas.

Mean = 2

MEAN: Take the arithmetic mean (“average”) of the updates across replicas.

OnlyFirstReplica = 3

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.

Implementations

impl VariableAggregation

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of VariableAggregation.

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

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

impl VariableAggregation

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 VariableAggregation

fn clone(&self) -> VariableAggregation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableAggregation

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

Formats the value using the given formatter.

impl Default for VariableAggregation

fn default() -> VariableAggregation

Returns the “default value” for a type.

impl From<VariableAggregation> for i32

fn from(value: VariableAggregation) -> i32

Converts to this type from the input type.

impl Hash for VariableAggregation

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 VariableAggregation

fn cmp(&self, other: &VariableAggregation) -> 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 VariableAggregation

fn eq(&self, other: &VariableAggregation) -> 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 VariableAggregation

fn partial_cmp(&self, other: &VariableAggregation) -> 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 VariableAggregation

impl Eq for VariableAggregation

impl StructuralPartialEq for VariableAggregation