GradientChecker

Struct GradientChecker 

Source
pub struct GradientChecker<T: FloatBounds + ScalarOperand + ToPrimitive> { /* private fields */ }
Expand description

Gradient checker for neural networks

Implementations§

Source§

impl<T: FloatBounds + ScalarOperand + ToPrimitive> GradientChecker<T>

Source

pub fn new(config: GradientCheckConfig<T>) -> Self

Create a new gradient checker

Source

pub fn check_network_gradients( &self, network: &mut SimpleMLP<T>, inputs: &Array2<T>, targets: &Array2<T>, loss_fn: &dyn LossFunction<T>, ) -> Result<GradientCheckResults<T>, SklearsError>

Check gradients for a neural network

Source

pub fn check_layer_gradients( &self, layer: &mut DenseLayer<T>, inputs: &Array2<T>, output_gradients: &Array2<T>, ) -> Result<GradientCheckResults<T>, SklearsError>

Check gradients for a single layer

Source§

impl<T: FloatBounds + ScalarOperand + ToPrimitive> GradientChecker<T>

Utility functions for gradient checking

Source

pub fn gradients_are_equal(&self, analytical: T, numerical: T) -> bool

Check if gradients are approximately equal

Source

pub fn compute_relative_error(&self, analytical: T, numerical: T) -> T

Compute relative error between two gradients

Source

pub fn generate_report(&self, results: &GradientCheckResults<T>) -> String

Generate a summary report of gradient checking results

Trait Implementations§

Source§

impl<T: Debug + FloatBounds + ScalarOperand + ToPrimitive> Debug for GradientChecker<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for GradientChecker<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for GradientChecker<T>
where T: RefUnwindSafe,

§

impl<T> Send for GradientChecker<T>

§

impl<T> Sync for GradientChecker<T>

§

impl<T> Unpin for GradientChecker<T>
where T: Unpin,

§

impl<T> UnwindSafe for GradientChecker<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> 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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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