Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark JAX experimental #2618

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Mark JAX experimental #2618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
324845e
mark jax experimental
FFroehlich Dec 5, 2024
f1cb799
add JAX import warning to pyest.ini
FFroehlich Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pytest.ini
View file
Open in desktop
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
View file
Open in desktop
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(

Check warning on line 15 in python/sdist/amici/jax/__init__.py

View check run for this annotation

Codecov / codecov/patch

python/sdist/amici/jax/__init__.py#L15 

Added line #L15 was not covered by tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be added to the ignore list in pytest.ini, I think.

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

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