Enum ReduceOp 

pub enum ReduceOp {
    Sum,
    Mean,
    Max,
    Min,
    Product,
}

Reduction operators supported by the ring all-reduce.

The associative combine used during the reduce-scatter phase is exposed via ReduceOp::apply, and the neutral element of that combine via ReduceOp::identity. ReduceOp::Mean reuses the additive combine and is finalised by dividing the accumulated sum by the world size.

Variants

Sum

Elementwise sum across all workers.

Mean

Elementwise arithmetic mean across all workers (sum divided by world size).

Max

Elementwise maximum across all workers.

Min

Elementwise minimum across all workers.

Product

Elementwise product across all workers.

Implementations

impl ReduceOp

pub fn apply<A: Float>(self, a: A, b: A) -> A

Combine two values with this operator.

Mean uses the same additive combine as Sum; the division by the world size is applied once at the end of the reduction (see ReduceOp::needs_mean_finalize).

pub fn identity<A: Float>(self) -> A

Neutral element of the combine operator.

Folding identity with any value v via ReduceOp::apply yields v.

pub fn needs_mean_finalize(self) -> bool

Whether the accumulated result must be divided by the world size.

This is true only for ReduceOp::Mean.

Trait Implementations

impl Clone for ReduceOp

fn clone(&self) -> ReduceOp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReduceOp

impl Debug for ReduceOp

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

Formats the value using the given formatter.

impl Eq for ReduceOp

impl PartialEq for ReduceOp

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReduceOp