Skip to content

Commit abe7927

Browse files
authored
Merge pull request #1653 from danforthcenter/parallelization_docs_linking
Parallelization docs linking
2 parents e160b2a + 3a944b0 commit abe7927

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/parallel_config.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ to run workflows in parallel.
88
Create a configuration file from a template:
99

1010
```bash
11-
plantcv-run-workflow --template my_config.txt
11+
plantcv-run-workflow --template my_config.json
1212
```
1313

1414
*class* **plantcv.parallel.WorkflowConfig**
@@ -155,32 +155,32 @@ After defining the cluster, parameters are used to define the size of and reques
155155
environment. These settings are defined in the `cluster_config` parameter. We define by default the following
156156
parameters:
157157

158-
**n_workers**: (int, required, default = 1): the number of workers/slots to request from the cluster. Because we
158+
* **n_workers**: (int, required, default = 1): the number of workers/slots to request from the cluster. Because we
159159
generally use 1 CPU per image analysis workflow, this is effectively the maximum number of concurrently running
160160
workflows.
161161

162-
**cores**: (int, required, default = 1): the number of compute cores per workflow. This should be left as 1 unless a
162+
* **cores**: (int, required, default = 1): the number of compute cores per workflow. This should be left as 1 unless a
163163
workflow is designed to use multiple CPUs/cores/threads.
164164

165-
**memory**: (str, required, default = "1GB"): the amount of memory/RAM used per workflow. Can be set as a number plus
165+
* **memory**: (str, required, default = "1GB"): the amount of memory/RAM used per workflow. Can be set as a number plus
166166
units (KB, MB, GB, etc.).
167167

168-
**disk**: (str, required, default = "1GB"): the amount of disk space used per workflow. Can be set as a number plus
168+
* **disk**: (str, required, default = "1GB"): the amount of disk space used per workflow. Can be set as a number plus
169169
units (KB, MB, GB, etc.).
170170

171-
**log_directory**: (str, optional, default = `None`): directory where worker logs are stored. Can be set to a path or
171+
* **log_directory**: (str, optional, default = `None`): directory where worker logs are stored. Can be set to a path or
172172
environmental variable.
173173

174-
**local_directory**: (str, optional, default = `None`): dask working directory location. Can be set to a path or
174+
* **local_directory**: (str, optional, default = `None`): dask working directory location. Can be set to a path or
175175
environmental variable.
176176

177-
**job_extra_directives**: (dict, optional, default = `None`): extra parameters sent to the scheduler. Specified as a dictionary
177+
* **job_extra_directives**: (dict, optional, default = `None`): extra parameters sent to the scheduler. Specified as a dictionary
178178
of key-value pairs (e.g. `{"getenv": "true"}`).
179179

180180
!!! note
181181
`n_workers` is the only parameter used by `LocalCluster`, all others are currently ignored. `n_workers`, `cores`,
182182
`memory`, and `disk` are required by the other clusters. All other parameters are optional. Additional parameters
183-
defined in the [dask-jobqueu API](https://jobqueue.dask.org/en/latest/api.html) can be supplied.
183+
defined in the [dask-jobqueue API](https://jobqueue.dask.org/en/latest/api.html) can be supplied.
184184

185185
### Example
186186

docs/pipeline_parallel.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ a configuration file can be edited and input.
1818
To create a configuration file, run the following:
1919

2020
```bash
21-
plantcv-run-workflow --template my_config.txt
21+
plantcv-run-workflow --template my_config.json
2222

2323
```
2424

2525
The code above saves a text configuration file in JSON format using the built-in defaults for parameters. The parameters can be modified
2626
directly in Python as demonstrated in the [WorkflowConfig documentation](parallel_config.md). A configuration can be
2727
saved at any time using the `save_config` method to save for later use. Alternatively, open the saved config
28-
file with your favorite text editor and adjust the parameters as needed.
28+
file with your favorite text editor and adjust the parameters as needed (refer to the attributes section of
29+
[WorkflowConfig documentation](parallel_config.md) for details about each parameter).
2930

3031
**Some notes on JSON format:**
3132

0 commit comments

Comments
 (0)