8000 DOC Add bumping dependencies guidelines to maintainer doc by lesteve · Pull Request #31118 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Add bumping dependencies guidelines to maintainer doc #31118

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 7 commits into from
Apr 1, 2025

Conversation

lesteve
Copy link
Member
@lesteve lesteve commented Apr 1, 2025

As discussed during the monthly scikit-learn developer meeting.

Close #30888.

I reused the content of #30888 (comment).

I propose to add a script in maint_tools based on https://gist.github.com/lesteve/4a7d42bfaab461ab90fcdcc613d01081 in a separate PR.

Copy link
github-actions bot commented Apr 1, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 30b670c. Link to the linter CI: here

Comment on lines 381 to 398
Example for the upcoming scikit-learn 1.8 release
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The upcoming 1.8 release is scheduled around November/December, let's pretend
it will happen on 2025-12-01, Python 3.10 (released in October 2021) will be
more than 4 years old and will be dropped so our minimum supported Python will
be Python 3.11 (a bit more than 3 years old).

The dependencies minimum versions will be bumped as follow:

- python: 3.10 -> 3.11
- numpy: 1.22.0 -> 1.24.0 (oldest version with Python 3.11 wheels)
- scipy: 1.8.0 -> 1.10.0 (oldest scipy version with Python 3.11 wheels)
- pandas: 1.4.0 -> 1.5.0 (oldest pandas version with Python 3.11 wheels)
- matplotlib: 3.5.0 -> 3.6.0 (oldest matplotlib version with Python 3.11 wheels)
- joblib: 1.2.0 -> 1.3.0 (1.3.0 will be ~2 years 5 month old, 1.4.0 will be less than 2 years old)
- threadpoolctl: 3.1.0 -> 3.2.0 (3.2.0 will be ~2 years 5 months old, 3.3.0 will be less than 2 years old)

Copy link
Member

Choose a reason for hiding this comment

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

I don't think this part is needed.

Instead we could consolidate and include the script you linked in #30895 (comment) in maint_tools and link that here :)

Copy link
Member Author

Choose a reason for hiding this comment

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

I find an example helps understanding the rule but it also makes sense to keep it short. I guess I can always add a link to the github comment instead.

Copy link
Member

Choose a reason for hiding this comment

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

I find that it quickly becomes out-of-date and we let very old examples with very old version numbers in the doc that we never update or clean-up.
At least we should rephrase it a bit such that it's not using time relative to now and use absolute timings instead. For instance the upcoming scikit-learn 1.8 release. Similarly, The dependencies minimum versions will be bumped as follow: should be The dependencies minimum versions should be bumped as follow:.

Copy link
Member Author

Choose a reason for hiding this comment

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

I ended up adding the slightly hacky script I currently have. It can certainly be improved in future PRs.

lesteve and others added 2 commits April 1, 2025 16:50
Copy link
Member
@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

LGTM

@jeremiedbb jeremiedbb enabled auto-merge (squash) April 1, 2025 16:13
@jeremiedbb jeremiedbb merged commit 40b685b into scikit-learn:main Apr 1, 2025
34 checks passed
@lesteve lesteve deleted the bumping-guideline branch April 1, 2025 19:29
lucyleeow pushed a commit to lucyleeow/scikit-learn that referenced this pull request Apr 2, 2025
…rn#31118)

Co-authored-by: Tim Head <betatim@gmail.com>
Co-authored-by: Jérémie du Boisberranger <jeremie@probabl.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFC Write an explicit rule about bumping our minimum dependencies
3 participants
0