amici.sim.sundials.gradient_check

Finite Difference Check

This module provides functions to automatically check correctness of amici computed sensitivities using finite difference approximations

Functions

check_finite_difference(*, x0, model, ...[, ...])

Checks the computed sensitivity based derivatives against a finite difference approximation.

amici.sim.sundials.gradient_check.check_finite_difference(*, x0, model, solver, edata, ip, fields, atol=0.0001, rtol=0.0001, epsilon=0.001)

Checks the computed sensitivity based derivatives against a finite difference approximation.

Parameters:

• x0 (collections.abc.Sequence[float]) – parameter value at which to check finite difference approximation

• model (amici._installation.amici.Model) – amici model

• solver (amici._installation.amici.Solver) – amici solver

• edata (amici._installation.amici.ExpData) – exp data

• ip (int) – parameter index

• fields (list[str]) – rdata fields for which to check the gradient

• atol (float | None) – absolute tolerance for comparison

• rtol (float | None) – relative tolerance for comparison

• epsilon (float | None) – finite difference step-size

Return type:

None