Skip to content

Commit e77fb51

Browse files
committed
formatting in the docstring
add newlines to correctly render lists, make reference to other class a link
1 parent 3e4813a commit e77fb51

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

bayesflow/simulators/model_comparison_simulator.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,20 @@ def __init__(
4242
If neither `p` nor `logits` is provided, defaults to uniform logits.
4343
use_mixed_batches : bool, optional
4444
Whether to draw samples in a batch from different models.
45+
4546
- If True (default), each sample in a batch may come from a different model.
4647
- If False, the entire batch is drawn from a single model, selected according to model probabilities.
4748
key_conflicts : str, optional
4849
Policy for handling keys that are missing in the output of some models, when using mixed batches.
50+
4951
- "drop" (default): Drop conflicting keys from the batch output.
5052
- "fill": Fill missing keys with the specified value.
5153
- "error": An error is raised when key conflicts are detected.
5254
fill_value : float, optional
5355
If `key_conflicts=="fill"`, the missing keys will be filled with the value of this argument.
5456
shared_simulator : Simulator or Callable, optional
5557
A shared simulator whose outputs are passed to all model simulators. If a function is
56-
provided, it is wrapped in a `LambdaSimulator` with batching enabled.
58+
provided, it is wrapped in a :py:class:`~bayesflow.simulators.LambdaSimulator` with batching enabled.
5759
"""
5860
self.simulators = simulators
5961

0 commit comments

Comments
 (0)