Skip to content

Commit a94dbee

Browse files
committed
Add allow_seeded_parallel_processing option to CLI
1 parent 2b87434 commit a94dbee

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

improver/cli/stochastic_noise.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ def process(
1919
db_threshold_units: str = "mm/hr",
2020
num_workers: int = None,
2121
scale_non_positive_noise=False,
22+
allow_seeded_parallel_processing: bool = False,
2223
):
2324
"""
2425
Class to apply spatially-structured stochastic noise to non-positive regions of a
@@ -75,6 +76,12 @@ def process(
7576
noise to non-positive regions, which could artificially increase values
7677
where the input cube indicates no signal should occur.
7778
Default is False.
79+
allow_seeded_parallel_processing:
80+
If True, allows multiple workers to be used even when a seed is
81+
provided in ssft_generate_params. This may improve computation speed,
82+
but can introduce run-to-run variation because pySTEPS uses global RNG
83+
seeding. If False, seeded runs are forced to a single worker for
84+
reproducibility. Default is False.
7885
7986
Returns:
8087
Cube with added stochastic noise.
@@ -101,6 +108,7 @@ def process(
101108
"db_threshold": db_threshold,
102109
"db_threshold_units": db_threshold_units,
103110
"scale_non_positive_noise": scale_non_positive_noise,
111+
"allow_seeded_parallel_processing": allow_seeded_parallel_processing,
104112
}
105113
if num_workers is not None:
106114
plugin_kwargs["num_workers"] = num_workers

0 commit comments

Comments
 (0)