Caution about rolling ball performance #7424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
And suggest alternatives for when something faster is desired.
jni
added
the
📄 type: Documentation
jni
approved these changes
May 20, 2024
There was a problem hiding this comment.
Added suggestions to follow numpydoc referencing syntax, but otherwise LGTM! Thanks @ctrueden!
stefanv
reviewed
May 20, 2024
Co-authored-by: Juan Nunez-Iglesias <jni@fastmail.com>
Co-authored-by: Juan Nunez-Iglesias <jni@fastmail.com>
Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com>
ctrueden
force-pushed
the
rolling-ball-docs
branch
from
794cca9
to
b980cb9
Compare
stefanv
approved these changes
May 20, 2024
mkcor
approved these changes
May 21, 2024
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
|
I'm worried about linting so I'm not pressing merge. But lets try to not have this linger too long, there seems to be strong agreement that this should be merged! I think we can all agree with small one character additions to aid with grammar! Thank you @ctrueden |
|
Thanks all! Please let me know if there is anything else you would like done on my side to move this forward. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This patch adds detail to the
skimage.restoration.rolling_balldocstring, cautioning about the algorithm performance and suggesting alternatives for when something faster is desired.As discussed in #7423, the rolling ball algorithm complexity is such that larger radii and/or images with higher dimensionality can take quite some time to compute. Let's give the user some guidance about this so they can make informed decisions about how to proceed with their image processing.
Release note
For maintainers and optionally contributors, please refer to the instructions on how to document this PR for the release notes.