Skip to content

Commit

Permalink
Add local task server to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
WardLT committed Mar 9, 2024
1 parent 584723f commit 27af983
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/colmena.task_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ colmena.task\_server.globus
:undoc-members:
:show-inheritance:

colmena.task\_server.local
--------------------------

.. automodule:: colmena.task_server.local
:members:
:undoc-members:
:show-inheritance:


colmena.task\_server.base
---------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/task-servers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,11 @@ Like Parsl, the task server is defined using a list of methods mapped to the res
Unlike Parsl, the execution resources are defined using the ID of a Globus Compute endpoint rather than a name of a specific executor.
Any configuration for how that endpoint actually provides compute resources (e.g., launching Kubernetes pods, requesting HPC jobs)
is provided when setting up the endpoint (see `Globus Compute docs <https://funcx.readthedocs.io/en/latest/endpoints.html#example-configurations>`_).

Python's Native executor
------------------------

The :class:`~colmena.task_server.local.LocalTaskServer` is backed by Python's native :class:`~concurrent.futures.Executor` classes.
It is useful for developing new Colmena workflows because it runs with minimal configuraiton.
``LocalTaskServer`` will automatically run workers on as many threads as your computer has processors,
though you can configure it to use separate processes and change the number of workers.

0 comments on commit 27af983

Please sign in to comment.