Skip to content

Commit

Permalink
doc ModelHash->Model in analysis.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
dilpath committed Jan 7, 2025
1 parent 8d2f0a0 commit 8c68099
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,20 @@ to get a quick overview over all models, as a pandas dataframe.

Additionally, see the Python API docs for the :mod:`petab_select.analyze` module, which contains some methods to subset and group models,
or compute "weights" (e.g. Akaike weights).

Model hashes
^^^^^^^^^^^^

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

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`.

.. code-block:: language
ModelHash.from_hash("M1-000").get_model(petab_select_problem)
You can use this to get the uncalibrated version of a calibrated model.

.. code-block:: language
model.hash.get_model(petab_select_problem)

0 comments on commit 8c68099

Please sign in to comment.