API overview

User-facing modules and classes. Each API reference page is also accessible from the sidebar under API reference.

Inference

Inference API — OverdampedLangevinInference, UnderdampedLangevinInference, InferenceResultSF, SparseScorer, SparsityResult, serialization helpers.

State functions

State function API — Basis, PSF, SF, Interactor, factories and parameter handling.

Bases

Bases API — pre-built polynomial, structural, linear and pair-interaction bases from SFI.bases.

Trajectory handling

Trajectory API — TrajectoryCollection constructors, I/O, collection operations, and streaming interface. On-disk file formats are specified in Trajectory file formats.

Simulation

Simulation API — OverdampedProcess, UnderdampedProcess.

Diagnostics

Diagnostics — assess() and the standardised-innovation test suite for validating a fitted model on real data.

Integration backend

SFI.integrate provides the JIT-compiled time-averaging engine used internally by the inference classes (integrate(), make_parametric_integrator(), Integrand, Term, stream() / timeop() / velocity()). Backend module — not intended for user code. See the Integration backend row of the API map (_project_index/api_map.md#sfiintegrate) for the symbol inventory.

Conceptual guides

Not reference pages, but you will land on them often from the API:

  • Physics Reference — all SDEs, drift / diffusion conventions, and the mapping between symbols in the math and identifiers in the source.

  • Building bases — decision tree for choosing between compositional primitives and factory builders, with canonical patterns (Lorenz, harmonic UD, limit cycle, double-well).