[Documentation] Cores and threads_per_core
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77
- Forks
- 7
- Avg merge
- 10h 32m
- Merged PRs (30d)
- 12
Description
The cores parameter is only useful when being used with mpi4py which is still a minority of the users of executorlib. So one suggestion would be to rename cores to mpi4py_cores and have the product of cores and threads_per_core accessible to the user under the variable name cores. But such a change would break the current examples and be confusing for users who are familiar with the current functionality, so it is not something I can do easily at the moment.
At the moment I extended the current documentation, to help clarify the confusion:
https://github.com/pyiron/executorlib/pull/998
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the current documentation and the proposed changes in pull request 998, with attention to the cores and threads_per_core parameters and existing examples. Determine whether the documentation sufficiently explains their relationship; done means the behavior and terminology are clear without requiring a parameter rename.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, hpc
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100