Struct GradientCheckResults

Source

pub struct GradientCheckResults<T: Float> {
    pub all_passed: bool,
    pub num_checked: usize,
    pub num_passed: usize,
    pub max_relative_error: T,
    pub max_absolute_error: T,
    pub avg_relative_error: T,
    pub avg_absolute_error: T,
    pub parameter_results: Vec<ParameterGradientResult<T>>,
}

Expand description

Results of gradient checking

Fields§

§all_passed: bool

Whether all gradients passed the check

§num_checked: usize

Number of parameters checked

§num_passed: usize

Number of parameters that passed

§max_relative_error: T

Maximum relative error found

§max_absolute_error: T

Maximum absolute error found

§avg_relative_error: T

Average relative error

§avg_absolute_error: T

Average absolute error

§parameter_results: Vec<ParameterGradientResult<T>>

Detailed results for each parameter

Trait Implementations§

Source §

impl<T: Clone + Float> Clone for GradientCheckResults<T>

Source §

fn clone(&self) -> GradientCheckResults<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<T: Debug + Float> Debug for GradientCheckResults<T>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> UnwindSafe for GradientCheckResults<T>
where T: UnwindSafe,

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<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> 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 §