Skip to main content

GradientDiagnostics

Struct GradientDiagnostics

pub struct GradientDiagnostics {
    pub status: GradientStatus,
    pub primal_residual: Option<f64>,
    pub backward_residual: Option<f64>,
    pub spectral_gap: Option<f64>,
    pub primal_applications: usize,
    pub backward_applications: usize,
    pub recomputations: usize,
}

Expand description

Backend-independent evidence returned with a native derivative.

Fields§

§status: GradientStatus

Reliability classification.

§primal_residual: Option<f64>

Optional primal numerical residual.

§backward_residual: Option<f64>

Optional reverse numerical residual.

§spectral_gap: Option<f64>

Optional spectral gap or separation diagnostic.

§primal_applications: usize

Number of component actions used by the primal/JVP computation.

§backward_applications: usize

Number of component actions used by the reverse computation.

§recomputations: usize

Number of forward states or actions recomputed by the reverse pass.

Trait Implementations§

impl Clone for GradientDiagnostics

fn clone(&self) -> GradientDiagnostics

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

impl Debug for GradientDiagnostics

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

Formats the value using the given formatter. Read more

impl PartialEq for GradientDiagnostics

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GradientDiagnostics

Auto Trait Implementations§

impl Freeze for GradientDiagnostics

impl RefUnwindSafe for GradientDiagnostics

impl Send for GradientDiagnostics

impl Sync for GradientDiagnostics

impl Unpin for GradientDiagnostics

impl UnsafeUnpin for GradientDiagnostics

impl UnwindSafe for GradientDiagnostics

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByRef<T> for T

fn by_ref(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,