Skip to content

Commit 6453533

Browse files
committed
update nb_runs documentation
1 parent ee71bc6 commit 6453533

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

src/vip_client/classes/VipGirder.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,8 @@ def launch_pipeline(
273273
- The dictionary can contain any object that can be converted to strings, or lists of such objects.
274274
- Lists of parameters launch parallel workflows on VIP.
275275
- `output_dir` (str) Path to the VIP folder where execution results will be stored.
276-
- `nb_runs` (int) Number of parallel workflows to launch with the same settings.
276+
- `nb_runs` (int) Number of parallel workflows to launch with the same settings
277+
(warning : this does not split, this duplicates).
277278
278279
Default behaviour:
279280
- Raises AssertionError in case of wrong inputs
@@ -310,7 +311,8 @@ def run_session(
310311
311312
|!| This function assumes that all session properties are already set.
312313
Optional arguments can be provided:
313-
- Increase `nb_runs` to run more than 1 execution at once;
314+
- Increase `nb_runs` to run more than 1 execution at once with the same settings
315+
(warning : this does not split, this duplicates).
314316
- Set `refresh_time` to modify the default refresh time.
315317
"""
316318
(self.launch_pipeline(nb_runs=nb_runs)

src/vip_client/classes/VipLauncher.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,8 @@ def launch_pipeline(
453453
- Lists of parameters launch parallel workflows on VIP.
454454
- `output_dir` (str) Path to the VIP folder where execution results will be stored.
455455
(Does not need to exist)
456-
- `nb_runs` (int) Number of parallel workflows to launch with the same `pipeline_id`/`input_settings`.
456+
- `nb_runs` (int) Number of parallel workflows to launch with the same settings
457+
(warning : this does not split, this duplicates).
457458
458459
Error profile:
459460
- Raises TypeError:
@@ -607,7 +608,8 @@ def run_session( self, nb_runs=1, refresh_time=30) -> VipLauncher:
607608
608609
|!| This function assumes that all session properties are already set.
609610
Optional arguments can be provided:
610-
- Increase `nb_runs` to run more than 1 execution at once;
611+
- Increase `nb_runs` to run more than 1 execution at once with the same settings
612+
(warning : this does not split, this duplicates).
611613
- Set `refresh_time` to modify the default refresh time;
612614
"""
613615
# Run the pipeline

src/vip_client/classes/VipSession.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,8 @@ def launch_pipeline(
408408
- Run VipSession.show_pipeline(`pipeline_id`) to display these parameters.
409409
- The dictionary can contain any object that can be converted to strings, or lists of such objects.
410410
- Lists of parameters launch parallel workflows on VIP.
411-
- `nb_runs` (int) Number of parallel workflows to launch with the same `pipeline_id`/`input_settings`.
411+
- `nb_runs` (int) Number of parallel workflows to launch with the same settings
412+
(warning : this does not split, this duplicates).
412413
413414
Error profile:
414415
- Raises TypeError:
@@ -547,7 +548,8 @@ def run_session(
547548
|!| This method assumes that all session properties are already set.
548549
Optional arguments can still be provided:
549550
- Set `update_files` to False to avoid checking the input data on VIP;
550-
- Increase `nb_runs` to run more than 1 execution at once;
551+
- Increase `nb_runs` to run more than 1 execution at once with the same settings
552+
(warning : this does not split, this duplicates).
551553
- Set `refresh_time` to modify the default monitoring time;
552554
- Set `get_status` to download files from workflows with a specific status
553555
- Set unzip to False to avoid extracting .tgz files during the download.

0 commit comments

Comments
 (0)