From c940594248a3d884ecb5387d073e969b94d62c80 Mon Sep 17 00:00:00 2001 From: Martin Schubert Date: Mon, 21 Oct 2024 11:37:00 -0700 Subject: [PATCH] fix docstring --- src/invrs_utils/experiment/work_unit.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/invrs_utils/experiment/work_unit.py b/src/invrs_utils/experiment/work_unit.py index e9d99c7..bb554d7 100644 --- a/src/invrs_utils/experiment/work_unit.py +++ b/src/invrs_utils/experiment/work_unit.py @@ -59,9 +59,10 @@ def run_work_unit( response_kwargs_fn: Function which computes keyword arguments to be supplied to the `challenge.component.response` method, given the step number. This enables e.g. evaluation with random wavelengths at each step. - save_params_strategy: If `True`, all binary designs will be saved to the - work unit directory. If `False`, only the champion design stored along with - the checkpoint will be retained. + save_params_strategy: Determines the strategy for saving parameters. If the + strategy is `all`, params are saved at every step. The `binary` strategy + only saves at steps where the params have a binarization degree of `1`. If + the strategy is `None`, parameters are not saved (except via checkpoint). save_interval_steps: The interval at which checkpoints are saved to `wid_path`. max_to_keep: The maximum number of checkpoints to keep. num_replicas: The number of replicas for the work unit. Each replica is