pyiron / pyiron/executorlib

[Documentation] Explain how to access the executorlib_worker_id for debugging

Open
#749 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
77
Forks
7
Avg merge
10h 32m
Merged PRs (30d)
12

Description

The functionality was added in: https://github.com/pyiron/executorlib/pull/748

Basically, the worker ID is available as input parameter to your functions named executorlib_worker_id, so if you have a function like this:

def my_function(a, b, executorlib_worker_id): 
    ...

And you submit it to an executor like this:

exe.submit(my_function, a=1, b=2)

Then executorlib automatically sets the executorlib_worker_id input parameter at the point when the function is executed on the worker, in analogy to the init_function: https://executorlib.readthedocs.io/en/latest/1-single-node.html#performance-optimization

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing single-node performance-optimization documentation and the functionality introduced by pull request #748. Add an example showing executorlib_worker_id in a submitted function and explain that the executor supplies it when the function runs; the documentation should make the debugging workflow clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.