Skip to content

Commit

Permalink
Doc: Update RTD landing page
Browse files Browse the repository at this point in the history
Add a bit of content. #95.
  • Loading branch information
dweindl committed Nov 12, 2024
1 parent 3708506 commit 56f16d9
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,55 @@
Welcome to petab-select's documentation!
========================================

PEtab Select brings
`model selection <https://en.wikipedia.org/wiki/Model_selection>`_ to
`PEtab <https://petab.readthedocs.io/>`_. PEtab Select comprises file
formats, a Python library and a command line interface.

Model selection is the process of choosing the best model from a set of
candidate models. PEtab Select provides a standardized and compact way to
specify the candidate model space, implements a number model selection
algorithms and criteria.

Supported model selection algorithms:

* brute force
* forward selection
* backward selection
* FAMoS

Supported model selection criteria:

* (corrected) Akaike Information Criterion (AIC / cAIC)
* Bayesian Information Criterion (BIC)
* ...

Model calibration is performed outside of PEtab Select. For example,
PEtab Select is well-integrated with
`pypesto <https://pypesto.readthedocs.io/>`_
(`model selection example <https://pypesto.readthedocs.io/en/latest/example/model_selection.html>`_).
Other model calibration tools can easily be integrated using the provided
Python library or command line interface.

Installation
------------

The Python 3 package provides both the Python 3 and command-line (CLI)
interfaces, and can be installed from PyPI, with

.. code-block:: bash
pip install petab-select
.. toctree::
:maxdepth: 2
:caption: Contents:

problem_definition
examples
Test Suite <test_suite>
api
problem_definition


Indices and tables
Expand Down

0 comments on commit 56f16d9

Please sign in to comment.