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.

Sign up for GitHub

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

Change title for plugins documentation #6733

Merged
merged 2 commits into from
Jul 26, 2022
Merged

Change title for plugins documentation #6733

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b9d6ae
change header for plugins
scharlottej13 Jul 15, 2022
3eab3f5
Apply suggestions from code review
jacobtomlinson Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/source/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
Plugins
~~~~~~~

Dask's plugin system enables you to run custom Python code for certain events. You can use plugins
that are specific to schedulers, workers, or nannies. A worker plugin, for example,
allows you to run custom Python code on all your workers at certain event in the worker's lifecycle (e.g. when the worker process is started).
In each section below, you'll see how to create your own plugin or use a Dask-provided built-in
plugin.

Scheduler Plugins
=================

Expand Down Expand Up @@ -81,6 +90,15 @@ Worker Plugins
for creating your own worker plugins. In addition, Dask provides some
:ref:`built-in plugins <plugins.builtin>`.

Watch the video below for an example using a ``WorkerPlugin`` to add a
:py:class:`concurrent.futures.ProcessPoolExecutor`:

.. raw:: html

<iframe width="560"
height="315" src="https://www.youtube.com/embed/vF2VItVU5zg?start=468"
style="margin: 0 auto 20px auto; display: block;" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

.. autoclass:: distributed.diagnostics.plugin.WorkerPlugin
:members:

Expand Down