Struct GradCheckResult 

pub struct GradCheckResult {
    pub num_params: usize,
    pub num_errors: usize,
    pub max_error: f64,
    pub max_rel_error: f64,
    pub avg_error: f64,
    pub passed: bool,
    pub errors: Vec<GradientError>,
}

Result of gradient checking

Fields

num_params: usize

Number of parameters checked

num_errors: usize

Number of mismatches found

max_error: f64

Maximum absolute error

max_rel_error: f64

Maximum relative error

avg_error: f64

Average absolute error

passed: bool

Whether all gradients passed the check

errors: Vec<GradientError>

Detailed error information

Implementations

impl GradCheckResult

pub fn new(num_params: usize) -> Self

Create a new result

pub fn add_error(&mut self, error: GradientError)

Add an error to the result

pub fn finalize(self) -> Self

Finalize the result by computing averages

pub fn summary(&self) -> String

Generate a summary report

pub fn print_errors(&self, max_to_print: usize)

Print detailed error report

Trait Implementations

impl Clone for GradCheckResult

fn clone(&self) -> GradCheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GradCheckResult

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

Formats the value using the given formatter.