Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstring for batch_size in client.map #7833

Merged
merged 1 commit into from May 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions distributed/client.py
Expand Up @@ -2016,12 +2016,12 @@ def map(
Whether or not the function is pure. Set ``pure=False`` for
impure functions like ``np.random.random``.
See :ref:`pure functions` for more details.
batch_size : int, optional
batch_size : int, optional (default: just one batch whose size is the entire iterable)
Submit tasks to the scheduler in batches of (at most)
``batch_size``.
Larger batch sizes can be useful for very large ``iterables``,
as the cluster can start processing tasks while later ones are
submitted asynchronously.
The tradeoff in batch size is that large batches avoid more per-batch overhead,
but batches that are too big can take a long time to submit and unreasonably delay
the cluster from starting its processing.
**kwargs : dict
Extra keyword arguments to send to the function.
Large values will be included explicitly in the task graph.
Expand Down