pub struct GradientCompressor<A: Float, D: Dimension> { /* private fields */ }Expand description
Gradient compression engine
Implementations§
Source§impl<A: Float + ScalarOperand + Debug + Send + Sync, D: Dimension + Send + Sync> GradientCompressor<A, D>
impl<A: Float + ScalarOperand + Debug + Send + Sync, D: Dimension + Send + Sync> GradientCompressor<A, D>
Sourcepub fn new(strategy: CompressionStrategy) -> Self
pub fn new(strategy: CompressionStrategy) -> Self
Create a new gradient compressor
Sourcepub fn initialize_error_state(&mut self, gradientshapes: &[Array<A, D>])
pub fn initialize_error_state(&mut self, gradientshapes: &[Array<A, D>])
Initialize error state for error feedback compression
Sourcepub fn compress(
&mut self,
gradients: &[Array<A, D>],
) -> Result<CompressedGradient<A>>
pub fn compress( &mut self, gradients: &[Array<A, D>], ) -> Result<CompressedGradient<A>>
Compress gradients
Sourcepub fn decompress(
&self,
compressed: &CompressedGradient<A>,
) -> Result<Vec<Array<A, D>>>
pub fn decompress( &self, compressed: &CompressedGradient<A>, ) -> Result<Vec<Array<A, D>>>
Decompress gradients
Sourcepub fn stats(&self) -> &CompressionStats
pub fn stats(&self) -> &CompressionStats
Get compression statistics
Sourcepub fn reset_stats(&mut self)
pub fn reset_stats(&mut self)
Reset compression statistics
Trait Implementations§
Auto Trait Implementations§
impl<A, D> Freeze for GradientCompressor<A, D>
impl<A, D> RefUnwindSafe for GradientCompressor<A, D>where
D: RefUnwindSafe,
A: RefUnwindSafe,
impl<A, D> Send for GradientCompressor<A, D>where
A: Send,
impl<A, D> Sync for GradientCompressor<A, D>where
A: Sync,
impl<A, D> Unpin for GradientCompressor<A, D>where
D: Unpin,
impl<A, D> UnwindSafe for GradientCompressor<A, D>where
D: UnwindSafe,
A: RefUnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.