Struct AdaptiveClippingStats

Source

pub struct AdaptiveClippingStats {
    pub current_threshold: f64,
    pub target_quantile: f64,
    pub clipping_frequency: f64,
    pub avg_gradient_norm: f64,
    pub std_gradient_norm: f64,
    pub adaptation_rate: f64,
    pub quantile_estimate: f64,
    pub threshold_updates: usize,
}

Expand description

Adaptive clipping statistics

Fields§

§current_threshold: f64

Threshold currently in force.

§target_quantile: f64

Target fraction of unclipped gradients.

§clipping_frequency: f64

EMA of the clipping indicator.

§avg_gradient_norm: f64

Mean observed gradient norm.

§std_gradient_norm: f64

Std deviation of observed gradient norms.

§adaptation_rate: f64

Geometric adaptation rate.

§quantile_estimate: f64

P-squared estimate of the target quantile of gradient norms.

§threshold_updates: usize

Number of privatized threshold updates performed.

Trait Implementations§

Source §

impl Clone for AdaptiveClippingStats

Source §

fn clone(&self) -> AdaptiveClippingStats

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for AdaptiveClippingStats

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for AdaptiveClippingStats

Blanket Implementations§

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §