Skip to main content

GradientChecker

Struct GradientChecker 

Source
pub struct GradientChecker { /* private fields */ }
Expand description

Gradient checker for multi-parameter functions

Implementations§

Source§

impl GradientChecker

Source

pub fn new(config: GradCheckConfig) -> Self

Create a new gradient checker with the given configuration

Source

pub fn with_defaults() -> Self

Create with default configuration

Source

pub fn check_parameter( &mut self, param_id: String, forward_fn: impl Fn(&[f64]) -> f64, x: &[f64], analytical_grad: &[f64], ) -> GradCheckResult

Check gradients for a single parameter

Source

pub fn results(&self) -> &HashMap<String, GradCheckResult>

Get results for all checked parameters

Source

pub fn all_passed(&self) -> bool

Check if all parameters passed

Source

pub fn total_errors(&self) -> usize

Get total number of errors across all parameters

Source

pub fn print_summary(&self)

Print summary of all checks

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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