Skip to content

Commit

Permalink
Mark JAX experimental (#2618)
Browse files Browse the repository at this point in the history
* mark jax experimental

* add JAX import warning to pyest.ini
  • Loading branch information
FFroehlich authored Dec 5, 2024
1 parent 0d49041 commit d1c8250
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
1 change: 1 addition & 0 deletions pytest.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ filterwarnings =
ignore:Conservation laws for non-constant species in models with Species-AssignmentRules are currently not supported and will be turned off.:UserWarning
ignore:Conservation laws for non-constant species in combination with parameterized stoichiometric coefficients are not currently supported and will be turned off.:UserWarning
ignore:Support for PEtab2.0 is experimental!:UserWarning
ignore:The JAX module is experimental and the API may change in the future.:ImportWarning
# hundreds of SBML <=5.17 warnings
ignore:.*inspect.getargspec\(\) is deprecated.*:DeprecationWarning
# pysb warnings
Expand Down
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 d1c8250

Please sign in to comment.