Skip to main content

jaxhybridmodels

A JAX/Equinox library for fitting user-written ODE models whose parameters or rate laws are learned from data. Learned quantities stay inside declared physical bounds, experiments may be sampled at irregular times, and training uses Optax or Evosax.

Documentation

https://danielepessina.github.io/jax-hybridmodels/. Start with Getting started, pick a modelling pattern from the Examples, and look up exact signatures in the API reference.

Need Start here
Understand the model contract Model interface
Build irregular data Data and buckets
Choose predictors and bounds Predictors and bounds
Train or freeze parameters Training
Extend the library Custom predictors

First run

The examples are plain scripts. From a checkout:

uv sync --extra examples
uv run python examples/pendulum/train_harmonic.py

It fits the frequency of a harmonic oscillator to noisy position data with HybridModel.fit, then predicts the data and simulates a new initial condition. The Getting started page walks through a one-oscillator version of the same code.

Installation

From PyPI

uv add jax-hybridmodels

The distribution is jax-hybridmodels; the import is jaxhybridmodels. Add jax-hybridmodels[pandas] for PredictionResult.to_dataframe.

Development

uv sync --extra examples

This installs the package in editable mode plus the examples' extra dependencies. Plain uv sync installs the library alone.

Contributing

Run the verification checks before pushing:

uv run ruff check .                            # lint
uv run ruff format --check .                   # formatting
uv run ty check src tests examples scripts     # typecheck (needs --extra examples)
uv run pytest -q                               # test suite, about three minutes
uv run pytest -q -m slow                       # slow example tests
npm --prefix docs run docs:check               # API sync + site build

The first three also run as pre-commit hooks. Install them once with uvx pre-commit install.

See docs/README.md for local preview, API generation, and Pages deployment details.

License

BSD-3-Clause. See LICENSE.

Metadata

Release files for jax-hybridmodels 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jax-hybridmodels 0.3.0
File Size Uploaded Provenance Actions
jax_hybridmodels-0.3.0.tar.gz 527.7 kB With provenance Details for jax_hybridmodels-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jax-hybridmodels 0.3.0
File Interpreter ABI Platform Actions
jax_hybridmodels-0.3.0-py3-none-any.whl Python 3 none any Details for jax_hybridmodels-0.3.0-py3-none-any.whl

Total release size: 755.7 kB

Release files / jax_hybridmodels-0.3.0.tar.gz

Download URL jax_hybridmodels-0.3.0.tar.gz
Size 527.7 kB
Tags Source
SHA-256 checksum
How to use checksums
68013cb203d26a22b838907d9f18c61cfe7e2cbc46a9a2db5fcf6d03005db75d
BLAKE2b-256 checksum
How to use checksums
e2dedd70c62b9e69e2c4ed70a6d1e3e7c5713500fc2bf3b9bc84ebab45c976d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / jax_hybridmodels-0.3.0-py3-none-any.whl

Download URL jax_hybridmodels-0.3.0-py3-none-any.whl
Size 228.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab9d55e7f74b3fb9c99fd207c25ae1c87faf9c5e08a5684d4227f1a653e51d64
BLAKE2b-256 checksum
How to use checksums
249968ab6c8fbf74916f3a89654aa73a6fa897dd0d50245a9b47c34314b8e464
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for jax-hybridmodels 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for jax_hybridmodels-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page