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

Use num_workers instead of alternate parameter names #7302

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

lagru
Copy link
Member

@lagru lagru commented Jan 19, 2024

Description

Closes #4876. Refer to the closed issue for the original discussion, which settled on workers or num_workers as the consistent name to use. I opted for the latter here, as it seemed more explicit.

Checklist

Release note

Summarize the introduced changes in the code block below in one or a few sentences. The
summary will be included in the next release notes automatically:

Deprecate parameter `num_threads` in `skimage.restoration.rolling_ball`; 
use `num_workers` instead.

"num_workers" is inline with what dask uses and also the most common
pattern currently for this kind of parameter.
@lagru lagru added 🔽 Deprecation Involves deprecation 📜 type: API Involves API change(s) 🥾 Path to skimage2 A step towards the new "API 2.0" labels Jan 19, 2024
@stefanv
Copy link
Member

stefanv commented Jan 19, 2024

I will comment on the original issue, but I'm not sure we landed on the correct naming.

@jarrodmillman
Copy link
Contributor

Maybe this should be coordinated across packages via a SPEC.

skimage/restoration/_rolling_ball.py Outdated Show resolved Hide resolved
lagru and others added 2 commits February 27, 2024 21:01
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
@mkcor mkcor added this to the 0.23 milestone Feb 28, 2024
@lagru lagru marked this pull request as draft March 10, 2024 14:21
@lagru
Copy link
Member Author

lagru commented Mar 10, 2024

Marking this as a draft for now.

@lagru lagru added the ⬆️ Upstream Needs help from or involves an upstream project label Mar 10, 2024
@jarrodmillman jarrodmillman removed this from the 0.23 milestone Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔽 Deprecation Involves deprecation ⬆️ Upstream Needs help from or involves an upstream project 🥾 Path to skimage2 A step towards the new "API 2.0" 📜 type: API Involves API change(s)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terminology: n_jobs vs num_workers vs ncpu etc.
4 participants