pub struct GradientChecker {
pub epsilon: f64,
pub rtol: f64,
pub atol: f64,
}Expand description
Gradient checker for numerical verification
Compares analytical gradients (from parameter-shift rule or adjoint method) with numerical gradients (finite differences) to verify correctness.
Fields§
§epsilon: f64Epsilon for finite differences
rtol: f64Relative tolerance for comparison
atol: f64Absolute tolerance for comparison
Implementations§
Source§impl GradientChecker
impl GradientChecker
Sourcepub fn with_epsilon(epsilon: f64) -> Self
pub fn with_epsilon(epsilon: f64) -> Self
Create with custom epsilon
Sourcepub fn with_tolerances(epsilon: f64, rtol: f64, atol: f64) -> Self
pub fn with_tolerances(epsilon: f64, rtol: f64, atol: f64) -> Self
Create with custom tolerances
Sourcepub fn numerical_gradient<F>(
&self,
param: &mut TQParameter,
param_idx: usize,
loss_fn: &mut F,
) -> Result<f64>
pub fn numerical_gradient<F>( &self, param: &mut TQParameter, param_idx: usize, loss_fn: &mut F, ) -> Result<f64>
Compute numerical gradient using finite differences
For function f and parameter θ: ∂f/∂θ ≈ [f(θ + ε) - f(θ - ε)] / (2ε)
Sourcepub fn check_gradient(
&self,
analytical: f64,
numerical: f64,
) -> GradientCheckResult
pub fn check_gradient( &self, analytical: f64, numerical: f64, ) -> GradientCheckResult
Check if analytical and numerical gradients match
Trait Implementations§
Auto Trait Implementations§
impl Freeze for GradientChecker
impl RefUnwindSafe for GradientChecker
impl Send for GradientChecker
impl Sync for GradientChecker
impl Unpin for GradientChecker
impl UnwindSafe for GradientChecker
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.