Example on coupled sweeps is incomplete and misleading
Description
The example on coupled sweeps in the user manual is incomplete and does not specify how exactly a sweep can be coupled to another sweep.
The example specifies a coupling to the my_first_param
parameter which is not part of the example. The configuration is misleading because it looks like the target_name
parameter is used to identify the coupling of two coupled-sweep
s, when it is actually used to attach to another sweep.
Proposal
Add a working example of a parameter sweep configuration
# Run configuration for MyModel
---
parameter_space:
# Regular sweep serves as target for coupled sweeps
seed: !sweep
default: 42
values: [1, 2, 4, 8]
MyModel:
my_coupled_param: !coupled-sweep
# Attach to sweep of parameter 'seed'
target_name: seed
# Define sweep values
default: foo
values: [foo, bar, baz, spam] # has to have same length as target
my_other_coupled_param: !coupled-sweep
# Attach to sweep of parameter 'seed'
target_name: seed
# Omitting values will import them from target 'seed'
Further questions
- Can the
target_name
also refer to anothercoupled-sweep
, or must the target be asweep
?
How to test the implementation?
Not sure if this should be tested...
Related issues
- #15 (closed): Collection of doc improvements
- #267: Docs are missing info on how to create a model config file
Edited by Utopia Developers