Skip to content

Commit d1c8250

Browse files
authored
Mark JAX experimental (#2618)
* mark jax experimental * add JAX import warning to pyest.ini
1 parent 0d49041 commit d1c8250

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

pytest.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ filterwarnings =
1212
ignore:Conservation laws for non-constant species in models with Species-AssignmentRules are currently not supported and will be turned off.:UserWarning
1313
ignore:Conservation laws for non-constant species in combination with parameterized stoichiometric coefficients are not currently supported and will be turned off.:UserWarning
1414
ignore:Support for PEtab2.0 is experimental!:UserWarning
15+
ignore:The JAX module is experimental and the API may change in the future.:ImportWarning
1516
# hundreds of SBML <=5.17 warnings
1617
ignore:.*inspect.getargspec\(\) is deprecated.*:DeprecationWarning
1718
# pysb warnings

python/sdist/amici/jax/__init__.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
"""Interface to facilitate AMICI generated models using JAX"""
1+
"""
2+
JAX
3+
---
4+
5+
This module provides an interface to generate and use AMICI models with JAX. Please note that this module is
6+
experimental, the API may substantially change in the future. Use at your own risk and do not expect backward
7+
compatibility.
8+
"""
9+
10+
from warnings import warn
211

312
from amici.jax.petab import JAXProblem, run_simulations
413
from amici.jax.model import JAXModel
514

15+
warn(
16+
"The JAX module is experimental and the API may change in the future.",
17+
ImportWarning,
18+
stacklevel=2,
19+
)
20+
621
__all__ = ["JAXModel", "JAXProblem", "run_simulations"]

0 commit comments

Comments
 (0)