Skip to content

Commit

Permalink
Fix SLURMRunner capitalisation
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobtomlinson committed Aug 22, 2024
1 parent b91983d commit 524d4c3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion dask_jobqueue/slurm.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ def __init__(self, *args, scheduler_file="scheduler-{job_id}.json", **kwargs):
if not scheduler_file:
raise RuntimeError(
"scheduler_file must be specified in either the "
"scheduler_options or as keyword argument to SlurmRunner."
"scheduler_options or as keyword argument to SLURMRunner."
)

# Encourage filename uniqueness by inserting the job ID
Expand Down
8 changes: 4 additions & 4 deletions docs/source/runners-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ variable to decide what role reach process should play and uses the shared files
# myscript.py
from dask.distributed import Client
from dask_jobqueue.slurm import SlurmRunner
from dask_jobqueue.slurm import SLURMRunner
# When entering the SlurmRunner context manager processes will decide if they should be
# When entering the SLURMRunner context manager processes will decide if they should be
# the client, schdeduler or a worker.
# Only process ID 1 executes the contents of the context manager.
# All other processes start the Dask components and then block here forever.
with SlurmRunner(scheduler_file="/path/to/shared/filesystem/scheduler-{job_id}.json") as runner:
with SLURMRunner(scheduler_file="/path/to/shared/filesystem/scheduler-{job_id}.json") as runner:
# The runner object contains the scheduler address info and can be used to construct a client.
with Client(runner) as client:
Expand All @@ -29,4 +29,4 @@ variable to decide what role reach process should play and uses the shared files
assert client.submit(lambda x: x + 1, 10).result() == 11
assert client.submit(lambda x: x + 1, 20, workers=2).result() == 21
# When process ID 1 exits the SlurmRunner context manager it sends a graceful shutdown to the Dask processes.
# When process ID 1 exits the SLURMRunner context manager it sends a graceful shutdown to the Dask processes.

0 comments on commit 524d4c3

Please sign in to comment.