Skip to content

Commit

Permalink
Improve documentation of starting workers on Slurm/PBS
Browse files Browse the repository at this point in the history
  • Loading branch information
Kobzol committed Nov 27, 2023
1 parent 47cc2b8 commit 9347f0b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ with the HyperQueue developers, you can use our [Zulip](https://hyperqueue.zulip
- Start worker on all nodes of a Slurm job

```bash
$ sbatch <your-params-of-sbatch> --wrap "srun hq worker start"
$ sbatch <your-params-of-sbatch> --wrap "srun --overlap hq worker start"
```

* Monitor the state of jobs
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Example submission script:

# Run a worker on all allocated nodes
ml OpenMPI
mpirun /<path-to-hyperqueue>/hq worker start --manager pbs
pbsdsh /<path-to-hyperqueue>/hq worker start --manager pbs
```

=== "Slurm"
Expand All @@ -66,7 +66,7 @@ Example submission script:

# Run a worker on all allocated nodes
ml OpenMPI
mpirun /<path-to-hyperqueue>/hq worker start --manager slurm
srun --overlap /<path-to-hyperqueue>/hq worker start --manager slurm
```

The worker will try to automatically detect that it is started under a PBS/Slurm job, but you can also explicitly pass
Expand Down

0 comments on commit 9347f0b

Please sign in to comment.