Skip to content

Commit db14613

Browse files
committed
library->package
1 parent e9819a3 commit db14613

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

doc/analysis.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Analysis
22
========
33

44
After using PEtab Select to perform model selection, you may want to operate on all "good" calibrated models.
5-
The PEtab Select Python library provides some methods to help with this. Please request any missing methods.
5+
The PEtab Select Python package provides some methods to help with this. Please request any missing methods.
66

77
See the Python API docs for the :class:`petab_select.Models` class, which provides some methods. In particular, :attr:`petab_select.Models.df` can be used
88
to get a quick overview over all models, as a pandas dataframe.
@@ -13,7 +13,7 @@ or compute "weights" (e.g. Akaike weights).
1313
Model hashes
1414
^^^^^^^^^^^^
1515

16-
Model hashes are special objects in the library, that are generated from model-specific information that is unique within a single PEtab Select problem.
16+
Model hashes are special objects in the package, that are generated from model-specific information that is unique within a single PEtab Select problem.
1717

1818
This means you can reconstruct the model given some model hash. For example, with this model hash `M1-000`, you can reconstruct the :class:`petab_select.ModelHash` from a string, then reconstruct the :class:`petab_select.Model`.
1919

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Welcome to PEtab Select's documentation!
99
PEtab Select brings
1010
`model selection <https://en.wikipedia.org/wiki/Model_selection>`_ to
1111
`PEtab <https://petab.readthedocs.io/>`_. PEtab Select comprises file
12-
formats, a Python library and a command line interface.
12+
formats, a Python package and a command line interface.
1313

1414
Model selection is the process of choosing the best model from a set of
1515
candidate models. PEtab Select provides a standardized and compact way to
@@ -40,7 +40,7 @@ PEtab Select is well-integrated with:
4040
(`example <https://pypesto.readthedocs.io/en/latest/example/model_selection.html>`__)
4141

4242
Other model calibration tools can easily be integrated using the provided
43-
Python library or command line interface.
43+
Python package or command line interface.
4444

4545
Installation
4646
------------

doc/problem_definition.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Model selection problems for PEtab Select are defined by the following files:
99

1010
The different file formats are described below. The YAML file formats
1111
come with a YAML-formatted JSON schema, such that these files can be
12-
easily worked with independently of the PEtab Select library.
12+
easily worked with independently of the PEtab Select package.
1313

1414
1. Selection problem
1515
--------------------
@@ -155,7 +155,7 @@ Brief format description
155155
- ``model_subspace_id``: Same as in the model space files.
156156
- ``model_subspace_indices``: The indices that locate this model in its model subspace.
157157
- ``criteria``: The value of the criterion by which model selection was performed, at least. Optionally, other criterion values too.
158-
- ``model_hash``: The model hash, generated by the PEtab Select library. The format is ``[MODEL_SUBSPACE_ID]-[MODEL_SUBSPACE_INDICES_HASH]``. If all parameters are in the model are defined like ``0;estimate``, then the hash is a string of ``1`` and ``0``, for parameters that are estimated or not, respectively.
158+
- ``model_hash``: The model hash, generated by the PEtab Select package. The format is ``[MODEL_SUBSPACE_ID]-[MODEL_SUBSPACE_INDICES_HASH]``. If all parameters are in the model are defined like ``0;estimate``, then the hash is a string of ``1`` and ``0``, for parameters that are estimated or not, respectively.
159159
- ``model_subspace_petab_yaml``: Same as in model space files.
160160
- ``estimated_parameters``: Parameter estimates, including all estimated parameters that are not in the model selection problem; i.e., parameters that are set to be estimated in the model subspace PEtab problem but don't appear in the column header of the model space file.
161161
- ``iteration``: The iteration of model selection in which this model appeared.

0 commit comments

Comments
 (0)