Skip to content

Commit

Permalink
subheadings
Browse files Browse the repository at this point in the history
  • Loading branch information
dilpath committed Dec 17, 2024
1 parent ec5b631 commit f36d70b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/problem_definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,13 @@ can be specified like
selected model.

Here, the format for a single model is shown. Multiple models can be specified
as a YAML list of the same format. The only required key is the ``petab_yaml``,
as a model requires a PEtab problem. Other keys are required in different
as a YAML list of the same format. Some optional keys are required in different
contexts (for example, model comparison will require ``criteria``).

Brief format description
^^^^^^^^^^^^^^^^^^^^^^^^


.. code-block:: yaml
model_subspace_id: # str (required).
Expand All @@ -146,5 +149,8 @@ contexts (for example, model comparison will require ``criteria``).
- ``parameters``: The parameter combination from the model space file that defines this model (either values or ``"estimate"``). Not the calibrated values, which are in ``estimated_parameters``!
- ``predecessor_model_hash``: The hash of the model that preceded this model during the model selection process. Will be ``virtual_initial_model-`` if the model had no predecessor model.

Schema
^^^^^^

.. literalinclude:: standard/model.yaml
:language: yaml

0 comments on commit f36d70b

Please sign in to comment.