8000 Unify API on seed keyword for random seeds / generator by grlee77 · Pull Request #6258 · scikit-image/scikit-image · GitHub
[go: up one dir, main page]

Skip to content

Unify API on seed keyword for random seeds / generator #6258

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

Merged
merged 16 commits into from
Apr 5, 2023

Conversation

grlee77
Copy link
Contributor
@grlee77 grlee77 commented Feb 21, 2022

Description

closes #5359

Unify on use of seed in the public API. Currently had a mixture of (sample_seed, seed, random_seed, random_state)

Checklist

  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only)
  • Benchmark in ./benchmarks, if your changes aren't covered by an
    existing benchmark
  • Unit tests
  • Clean style in the spirit of PEP8
  • Descriptive commit messages (see below)

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.
  • There is a bot to help automate backporting a PR to an older branch. For
    example, to backport to v0.19.x after merging, add the following in a PR
    comment: @meeseeksdev backport to v0.19.x
  • To run benchmarks on a PR, add the run-benchmark label. To rerun, the label
    can be removed and then added again. The benchmark output can be checked in
    the "Actions" tab.

@grlee77 grlee77 added the 📜 type: API Involves API change(s) label Feb 21, 2022
@grlee77 grlee77 added this to the 0.20 milestone Feb 21, 2022
@grlee77 grlee77 modified the milestones: 0.20, skimage2 Apr 1, 2022
@github-actions
Copy link

Hey, there hasn't been any activity on this pull request for more than 180 days. For now, we have marked it as "dormant" until there is some new activity. You are welcome to reach out to people by mentioning them here or on our forum if you need more feedback! Otherwise, we would be thankful for a short update, for example if you would like to continue or if you are okay with someone else doing so. In any case, thank you for your contributions so far!

Copy link
Member
@mkcor mkcor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguably the depreciation cycle is getting squeezed here (deprecated_version='0.20', removed_version='1.0'). I'm +1 in spite of this. /cc @scikit-image/core

@github-actions github-actions bot removed the 😴 Dormant No recent activity label Oct 6, 2022
@soupault
Copy link
Member
soupault commented Oct 8, 2022

The PR looks good 👍🏻 . Please, rebase onto the latest commit to rerun the tests.
It would be great also to have a reminder in TODO.txt to remove the deprecation wrappers in v1.0.

8000

@stefanv
Copy link
Member
stefanv commented Feb 7, 2023

@grlee77 This one is good to go, right? Do you want to rebase and get it into the forthcoming release?

@grlee77
Copy link
Contributor Author
grlee77 commented Feb 16, 2023

I was slow for 0.20, but the conflicts have now been fixed. Will need one more commit to update the versions listed for the warning from deprecate_kwarg.

@stefanv stefanv modified the milestones: skimage2, 0.21 Apr 4, 2023
@jarrodmillman
Copy link
Contributor

Shouldn't we add a note to TODO.txt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 type: API Involves API change(s)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API consistency: seed vs random_seed vs sample_seed
5 participants
0