Skip to content

Commit ebbddce

Browse files
committed
detail subsampling behavior docs for SIR simulator [no ci]
fixes #518
1 parent 887fbbc commit ebbddce

File tree

1 file changed

+3
-1
lines changed
  • bayesflow/simulators/benchmark_simulators

1 file changed

+3
-1
lines changed

bayesflow/simulators/benchmark_simulators/sir.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ def __init__(
3333
The number of initially recovered individuals.
3434
subsample: int or None, optional, default: 10
3535
The number of evenly spaced time points to return. If `None`,
36-
no subsampling will be performed and all `T` timepoints will be returned.
36+
no subsampling will be performed, all `T` timepoints will be returned
37+
and a trailing dimension will be added. If an integer is provided,
38+
subsampling is performed and no trailing dimension will be added.
3739
total_count: int, optional, default: 1000
3840
The `N` parameter of the binomial noise distribution. Used just
3941
for scaling the data and magnifying the effect of noise, such that

0 commit comments

Comments
 (0)