Skip to content

Commit

Permalink
mark jax experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
FFroehlich committed Dec 5, 2024
1 parent 0d49041 commit 324845e
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion python/sdist/amici/jax/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
"""Interface to facilitate AMICI generated models using JAX"""
"""
JAX
---
This module provides an interface to generate and use AMICI models with JAX. Please note that this module is
experimental, the API may substantially change in the future. Use at your own risk and do not expect backward
compatibility.
"""

from warnings import warn

from amici.jax.petab import JAXProblem, run_simulations
from amici.jax.model import JAXModel

warn(
"The JAX module is experimental and the API may change in the future.",
ImportWarning,
stacklevel=2,
)

__all__ = ["JAXModel", "JAXProblem", "run_simulations"]

0 comments on commit 324845e

Please sign in to comment.