Skip to content

Commit 529bfc7

Browse files
committed
Update parallelism docs
1 parent 8e076bb commit 529bfc7

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

docs/advanced_usage/9_parallelism.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Parallelism
22

33
To facilitate fast execution, SMAC supports executing multiple workers simultaneously via [Dask](https://www.dask.org/). Using this functionality, splits SMAC into a main, and executor jobs.
4-
The main job handles the Optimization Process, and coordination. The executors are queried with the target function and hyperparameter configurations, execute them, and return their result.
4+
The main job handles the optimization process, and coordinates the executor jobs. The executors are queried with the target function and hyperparameter configurations, execute them, and return their result.
55

66
!!! note
77

@@ -21,14 +21,14 @@ Scenario(model.configspace, n_workers=5)
2121
```
2222

2323

24-
## Parallelizing on a HPC (with SLURM)
24+
## Parallelizing on SLURM
2525

26-
To utilize this split of main and execution jobs on a [SLURM](https://slurm.schedmd.com/), ``SMAC`` supports manually specifying a [Dask](https://www.dask.org/) client.
27-
For example, this allows using independent jobs for execution, not necessarily running on the same machine/with identical hardware requirements as the main job.
26+
To utilize this split of main and execution jobs on a [SLURM cluster](https://slurm.schedmd.com/), SMAC supports manually specifying a [Dask](https://www.dask.org/) client.
27+
This allows executing the target function on dedicated SLURM jobs that are necessarily configured with the same hardware requirements,.
2828

2929
!!! note
3030

31-
While most ``SLURM`` clusters behave similarly, the example ``DASK`` client, might not work for every cluster. For example, some clusters only allow spawning new jobs
31+
While most SLURM clusters behave similarly, the example DASK client, might not work for every cluster. For example, some clusters only allow spawning new jobs
3232
from the login node.
3333

3434
To configure SMAC properly for each cluster, you need to know the ports which allow communication between main and worker jobs. The dask client is then created as follows:

examples/1_basics/7_parallelization_cluster.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ def train(self, config: Configuration, seed: int = 0) -> float:
7777
address=cluster,
7878
)
7979
client.wait_for_workers(n_workers)
80-
# Instead, you can also do
81-
# client = cluster.get_client()
8280

8381
# Now we use SMAC to find the best hyperparameters
8482
smac = BlackBoxFacade(

0 commit comments

Comments
 (0)