scirs2_autograd::testing::gradient_checking

Struct GradientChecker

pub struct GradientChecker<F: Float> { /* private fields */ }

Expand description

Gradient checking engine

Implementations§

Source §

impl<F: Float> GradientChecker<F>

Source

pub fn new() -> Self

Create a new gradient checker

Source

pub fn with_config(config: GradientCheckConfig) -> Self

Create with custom configuration

Source

pub fn check_scalar_function<'a, Func>( &'a self, function: Func, input: &'a Tensor<'a, F>, analytical_gradient: &'a Tensor<'a, F>, ) -> Result<GradientCheckResult<'a, F>, StabilityError>
where Func: for<'b> Fn(&Tensor<'b, F>) -> Result<Tensor<'b, F>, StabilityError>,

Check gradients of a scalar-valued function

Trait Implementations§

Source §

impl<F: Float> Default for GradientChecker<F>

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<F> UnwindSafe for GradientChecker<F>
where F: 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 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 §