From 2ca205b263796e70c84c1398488da9bed41e080b Mon Sep 17 00:00:00 2001 From: Matthew Rocklin Date: Thu, 3 Jan 2019 09:06:42 -0800 Subject: [PATCH] Remove reference to "get" scheduler functions in docs [skip ci] (#4350) --- docs/source/setup/single-machine.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/setup/single-machine.rst b/docs/source/setup/single-machine.rst index 22c9fc3c4d9..91e62302912 100644 --- a/docs/source/setup/single-machine.rst +++ b/docs/source/setup/single-machine.rst @@ -35,13 +35,14 @@ use this scheduler. However, you do have a choice between threads and processes: Selecting Threads, Processes, or Single Threaded ------------------------------------------------ -Currently, these options are available by selecting different ``get`` functions: +You can select between these options by specifying one of the following three +values to the ``scheduler=`` keyword: -- ``dask.threaded.get``: The threaded scheduler -- ``dask.multiprocessing.get``: The multiprocessing scheduler -- ``dask.local.get_sync``: The single-threaded scheduler +- ``"threads"``: Uses a ThreadPool in the local process +- ``"processes"``: Uses a ProcessPool to spread work between processes +- ``"single-threaded"``: Uses a for-loop in the current thread -You can specify these functions in any of the following ways: +You can specify these options in any of the following ways: - When calling ``.compute()``