Skip to main content

DistributedOptimizer

Struct DistributedOptimizer 

Source
pub struct DistributedOptimizer {
    pub strategy: AggregationStrategy,
    pub current_step: u64,
    pub dropped_updates: u64,
    /* private fields */
}
Expand description

Coordinator for distributed gradient aggregation across multiple workers.

Fields§

§strategy: AggregationStrategy

Aggregation strategy that governs when and how updates are combined.

§current_step: u64

The global training step counter.

§dropped_updates: u64

Number of updates that were rejected (staleness or other).

Implementations§

Source§

impl DistributedOptimizer

Source

pub fn new(strategy: AggregationStrategy) -> Self

Create a new optimizer with the given aggregation strategy.

Source

pub fn register_worker(&mut self, worker_id: WorkerId) -> bool

Register a worker.

Returns true if the worker was newly registered, false if it was already present (even if inactive).

Source

pub fn deregister_worker(&mut self, worker_id: &WorkerId) -> bool

Mark a worker as inactive (soft-deregister).

Returns true if the worker existed and was marked inactive, false if it was not found.

Source

pub fn submit_update( &mut self, update: GradientUpdate, now: u64, ) -> Result<(), OptimizerDistError>

Submit a gradient update from a worker.

§Errors
Source

pub fn try_aggregate(&mut self, layer_id: &str) -> Option<AggregatedGradient>

Attempt to aggregate pending updates for layer_id.

Returns Some(AggregatedGradient) if the strategy’s quorum condition is satisfied, None otherwise. On success the pending queue for that layer is cleared and the result is stored in aggregated.

Source

pub fn aggregate_gradients(updates: &[GradientUpdate]) -> Vec<f64>

Compute the element-wise mean of a slice of GradientUpdates.

Returns an empty vector if updates is empty or all gradient vectors are empty.

Source

pub fn advance_step(&mut self)

Advance the global training step by one.

For the AggregationStrategy::Synchronous strategy this also clears all pending updates left over from the previous step (workers that did not submit in time are implicitly skipped).

Source

pub fn active_workers(&self) -> Vec<&WorkerState>

Returns references to all active workers.

Source

pub fn worker_count(&self) -> usize

Total number of registered workers (active and inactive).

Source

pub fn active_worker_count(&self) -> usize

Number of currently active workers.

Source

pub fn pending_updates_for(&self, layer_id: &str) -> usize

Number of pending (not-yet-aggregated) updates for a layer.

Source

pub fn last_aggregated(&self, layer_id: &str) -> Option<&AggregatedGradient>

Returns the most recently aggregated gradient for a layer, if any.

Source

pub fn evict_stale_workers(&mut self, max_age_ms: u64, now: u64) -> usize

Mark workers inactive if their last_seen timestamp is older than now - max_age_ms.

Returns the number of workers evicted.

Source

pub fn stats(&self) -> DistOptimizerStats

Snapshot current optimizer statistics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more