Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 28 additions & 4 deletions doc/api.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
PEtab SciML Python API
=======================
======================

.. rubric:: Modules
Standard
--------

Read, write, and validate the PEtab SciML array data and neural network YAML
files.

.. autosummary::
:toctree: generated

petab_sciml.standard.ArrayData
petab_sciml.standard.ArrayDataStandard
petab_sciml.standard.NNModel
petab_sciml.standard.NNModelStandard
petab_sciml.standard.Input
petab_sciml.standard.add_array_files_to_yaml
petab_sciml.standard.extract_nn_yaml_parameters
petab_sciml.standard.extract_torch_parameters

petab_sciml.standard.nn_model
petab_sciml.standard.array_data

Problem utilities
-----------------

Helpers for constructing common PEtab SciML problem types from their
components.

.. autosummary::
:toctree: generated
:recursive:

petab_sciml
petab_sciml.standard
petab_sciml.problem_utils.neural_ode
petab_sciml.problem_utils
Binary file added doc/assets/hybrid_types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/hybrid_types_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
from __future__ import annotations

import inspect

Expand Down
420 changes: 259 additions & 161 deletions doc/examples/getting_started/getting_started.ipynb

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions doc/examples/getting_started/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ bleach==6.2.0
certifi==2025.8.3
cffi==2.0.0
charset-normalizer==3.4.3
chex==0.1.91
chex==0.1.90
cmake==4.1.0
cmake-build-extension==0.6.0
colorama==0.4.6
Expand Down Expand Up @@ -97,15 +97,15 @@ notebook==7.4.5
notebook_shim==0.2.4
numpy==2.2.3
opt_einsum==3.4.0
optax==0.2.6
optax==0.2.5
optimistix==0.0.10
oyaml==1.0
packaging==25.0
pandas==2.3.2
pandocfilters==1.5.1
parso==0.8.5
petab @ git+https://github.com/petab-dev/libpetab-python.git@99373c4340512def5a23bf2a75805c3f88251251
petab_sciml @ git+https://github.com/PEtab-dev/petab_sciml.git@80af726a3c2e430a068ea1ebf567f77c072fd85f#subdirectory=src/python
petab_sciml @ git+https://github.com/PEtab-dev/petab_sciml.git@main
pexpect==4.9.0
pillow==11.3.0
Pint==0.25
Expand Down
Binary file added doc/examples/getting_started/sim_hybrid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/examples/getting_started/sim_hybrid_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading