dask / dask-jobqueue

Deploy Dask on job schedulers like PBS, SLURM, and SGE
https://jobqueue.dask.org
BSD 3-Clause "New" or "Revised" License
235 stars 142 forks source link

Potentially confusing information about `processes` in the docs #635

Open Andrew-S-Rosen opened 8 months ago

Andrew-S-Rosen commented 8 months ago

The docs state

By default Dask will run one Python process per job

However, the docstring for processes says by default it is sqrt(cores). I suppose if cores is 1, the first statement is indeed true, but it can give a false impression.

guillaumeeb commented 8 months ago

Once again you are right, documentation should be updated, since we rely on https://github.com/dask/distributed/blob/main/distributed/deploy/utils.py#L16 to compute the default number of processes.