Skip to content

Commit d603a01

Browse files
authored
Delete develop branch
2 parents 68a9d5f + 4e6f4ce commit d603a01

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222

2323
steps:
2424
- name: Check out repository
25-
uses: actions/checkout@v4
25+
uses: actions/checkout@v5
2626

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

.github/workflows/deploy_release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
with:
2121
python-version: "3.12"
2222

23-
- uses: actions/checkout@v4
23+
- uses: actions/checkout@v5
2424
with:
2525
fetch-depth: 20
2626

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14183390.svg)](https://doi.org/10.5281/zenodo.14183390)
55

66

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

910
## Install
1011

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

1920
## Examples
2021

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

2426
## Supported features
2527

26-
### Criterion
28+
PEtab Select offers various methods and criteria for model selection, as well
29+
as a variety of visualization options.
2730

28-
- `AIC`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition
29-
- `AICc`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size
30-
- `BIC`: https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition
31+
### Criteria
32+
33+
- `AIC`: [Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition)
34+
- `AICc`: [Corrected Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size)
35+
- `BIC`: [Bayesian information criterion](https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition)
3136

3237
### Methods
3338

34-
- `forward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
35-
- `backward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
36-
- `brute_force`: Optimize all possible model candidates, then return the model
37-
with the best criterion value.
38-
- `famos`: https://doi.org/10.1371/journal.pcbi.1007230
39+
- `forward`:
40+
[Forward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
41+
Iteratively increase model complexity.
42+
- `backward`: [Backward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
43+
Iteratively decrease model complexity.
44+
- `brute_force`. Calibrate all models.
45+
- `famos`:
46+
[Flexible and dynamic Algorithm for Model Selection (FAMoS)](https://doi.org/10.1371/journal.pcbi.1007230)
3947

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

0 commit comments

Comments
 (0)