Skip to content

Commit 4fef870

Browse files
committed
doc clarification for grid importance runs
1 parent 1362661 commit 4fef870

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/grids.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,31 @@ After the main samples are generated, if you have ``importance_runs`` set you ca
2929

3030
cobaya-grid-run grid_folder --importance
3131

32+
33+
A note on importance_runs format
34+
--------------------------------
35+
36+
- Define importance_runs as a list of items. Each item is either:
37+
[names, info] or [names, info, optional_filter]
38+
where:
39+
- names: tag (or list of tags) used for the output suffix (e.g. .post.my_tag)
40+
- info: input-style dict or YAML file; if it lacks add/remove, it is treated as post.add
41+
- optional_filter (Python only): object with bool function want_importance(jobItem) to include conditionally
42+
- Place importance_runs either at the top level (applies to all groups) or
43+
inside a group (applies only to that group).
44+
45+
Minimal example (YAML) that just adds derived parameters:
46+
47+
.. code:: yaml
48+
49+
importance_runs:
50+
- ['derived',
51+
{params:
52+
{rdrag: {latex: '\\mathrm{r}_\\mathrm{drag}'},
53+
sigma8: {latex: '\\sigma_8'},
54+
thetastar: {latex: '\\theta_\\ast'}}}
55+
]
56+
3257
The grid also generates input files for minimization rather than sampling runs. If you also want best fits, run::
3358

3459
cobaya-grid-run grid_folder --minimize

0 commit comments

Comments
 (0)