Skip to main content

DistributedGradientAccumulator

Struct DistributedGradientAccumulator 

Source
pub struct DistributedGradientAccumulator {
    pub local_gradient: Vec<f32>,
    pub peer_gradients: HashMap<String, Vec<f32>>,
    /* private fields */
}
Expand description

Accumulates gradients from distributed peers via content-addressed storage.

Workflow:

  1. Call commit_local to serialize and store the local gradient, obtaining a Cid that can be broadcast to peers.
  2. Call add_peer_gradient for each CID received from a peer. The accumulator fetches the raw bytes from the BlockStore, decodes them via Arrow IPC, and caches the result.
  3. Once is_ready returns true, call aggregate to run FedAvg over all collected gradients (local + peers).

Fields§

§local_gradient: Vec<f32>

The local node’s gradient, set by commit_local.

§peer_gradients: HashMap<String, Vec<f32>>

Gradients received from peers, keyed by peer ID.

Implementations§

Source§

impl DistributedGradientAccumulator

Source

pub fn new(session_id: &str, config: BackwardPassConfig) -> Self

Create a new accumulator for the given session.

Source

pub async fn commit_local( &mut self, grad: Vec<f32>, store: &dyn BlockStore, ) -> Result<Cid>

Store the local gradient as Arrow IPC bytes in store, returning its CID.

The CID is computed as a raw-block CID (SHA-256) over the Arrow IPC bytes.

Source

pub async fn add_peer_gradient( &mut self, peer_id: &str, cid: &Cid, store: &dyn BlockStore, ) -> Result<()>

Fetch and decode a peer’s gradient from store using its CID.

Source

pub fn aggregate(&self) -> Result<Vec<f32>, GradientError>

Aggregate all collected gradients using the configured AggregationMethod.

Includes the local gradient plus all peer gradients collected so far. The aggregation strategy is taken from BackwardPassConfig::aggregation.

Source

pub fn is_ready(&self, min_peers: usize) -> bool

Returns true when at least min_peers peer gradients have been collected.

Source

pub fn session_id(&self) -> &str

The session identifier passed at construction time.

Source

pub fn peer_count(&self) -> usize

Number of peer gradients collected so far (not counting local).

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