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
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ jobs:

steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@v5

- name: Prepare python ${{ matrix.python-version }}
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ jobs:

steps:
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3.12"

- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 20

Expand Down
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14183390.svg)](https://doi.org/10.5281/zenodo.14183390)


The PEtab extension for model selection, including additional file formats and library.
The [PEtab](https://petab.readthedocs.io/) extension for model selection,
including the additional file formats and package.

## Install

Expand All @@ -18,24 +19,31 @@ Further documentation is available at

## Examples

There are example Jupyter notebooks covering the Python API, CLI, and visualization in the "doc/examples" directory.
There are example Jupyter notebooks covering visualization, custom non-SBML
models, and the CLI and Python API, in the `doc/examples` directory.
The notebooks can be viewed at [https://petab-select.readthedocs.io/en/stable/examples.html](https://petab-select.readthedocs.io/en/stable/examples.html).

## Supported features

### Criterion
PEtab Select offers various methods and criteria for model selection, as well
as a variety of visualization options.

- `AIC`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition
- `AICc`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size
- `BIC`: https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition
### Criteria

- `AIC`: [Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition)
- `AICc`: [Corrected Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size)
- `BIC`: [Bayesian information criterion](https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition)

### Methods

- `forward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
- `backward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
- `brute_force`: Optimize all possible model candidates, then return the model
with the best criterion value.
- `famos`: https://doi.org/10.1371/journal.pcbi.1007230
- `forward`:
[Forward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
Iteratively increase model complexity.
- `backward`: [Backward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
Iteratively decrease model complexity.
- `brute_force`. Calibrate all models.
- `famos`:
[Flexible and dynamic Algorithm for Model Selection (FAMoS)](https://doi.org/10.1371/journal.pcbi.1007230)

Note that the directional methods (forward, backward) find models with the
smallest step size (in terms of number of estimated parameters). For example,
Expand Down
Loading