-
-
Notifications
You must be signed in to change notification settings - Fork 26k
[MRG] Release Highlights for 0.22 #14846
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
Conversation
If an example, we should have it in its own directory?
Interesting effect of having as an example is that we need to keep the
highlights up to date if the same functionality is deprecated
|
I'm wondering whether it's worthwhile to maintain such an example. |
IMO having to maintain the highlights is actually a good thing. The maintenance should be very minimal, and it keeps the examples up to date. If that ever becomes a burden, that means that the main tools that we are releasing aren't mature enough, or poorly designed. And that would mean we have a much bigger problem.
I feel like it's not enough. There's no code example, no plot, and it's buried in a very long page so it doesn't stand out. It's not "engaging" Again, I'm not advocating for having this exact format for the highlights. This is just a preliminary example. |
I think you are thinking over too short a time-frame. How much of the code for 0.11 still works? I regularly have to fix sphinx errors in old whatsnews because we removed stuff. But indeed, the maintenance burden is not terrible. We already have all the other examples that we need to update, so having one more per class is not too bad. I think having a separate folder would be nice, though. Generally I'm +1 on this format. For the plotting, I would definitely show off the API more, say by plotting to classifiers in the same plot. |
So if we deprecate a class, we'll simply remove that part in the highlight, right?
The paragraph is linked to the API, and the API is linked to the example. This is what I think, but yes, this is not straightforward. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this format. Don't know if we want to go back and add Release Highlights for 0.21 (it would be nicely illustrative of the format).
Procedurally, is the burden on the feature contributor, or on the release manager, or on whomever, to create these?
fetch_openml('titanic', as_frame=True)
deserves demonstration.
I would say any core dev can take the initiative to create a PR (I'm happy to do it), and then ideally all core-devs make sure they're happy with it before we release. |
I think this is quite nice, particularly once the website design style is improved a bit.
The question who is responsible for it, and if it should block the release if for some reason it is not done (e.g. everyone is busy). I am very weary of anything that adds to the maintenance burden (particularly in the future), so I think it's better if we keep this optional: if someone is motivated enough to do it -- great, if not we release without it. WDYT? |
It's not that much work honestly. Far less than doing the actual release. Coming up with a decent version takes about <1h. Honestly I'm happy to be in charge of this. |
I think we should encourage feature contributors to add to the document if the feature is major enough? |
So the plan is to merge then iterate? |
Yes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need a readme file in release_highlights: Sphinx gallery is currently not generating a page for your highlights
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need a readme file in release_highlights: Sphinx gallery is currently not generating a page for your highlights
svc.fit(X_train, y_train) | ||
|
||
svc_disp = plot_roc_curve(svc, X_test, y_test) # compute once | ||
svc_disp.figure_.suptitle("ROC Curve") # adjust title after |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really making use of adjusting the plot after with our API? This seems to be highlighting an existing feature of matplotlib figures
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps it's better to organize the examples according to alphabetic order, which is consistent with classes.rst.
There're some other features (e.g., stacking) but we can add them in another PR.
What's the decision during the meeting? Can we merge?
doc/whats_new/v0.22.rst
Outdated
@@ -9,6 +9,10 @@ Version 0.22.0 | |||
|
|||
**In Development** | |||
|
|||
For a shortest description of the main highlights of the release, please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
short description?
plt.show() | ||
|
||
############################################################################# | ||
# Tree pruning |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it a (important) major feature? not sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we can decide before releasing, when other feature will added here
Here is a PR that does this: #15051 |
yes the goal would be to merge so that other contributors can submit PRs for their features |
I mean maybe we should have a way to organize the examples in this example. |
I think we should organise the highlights here by popularity :)
|
Addresses #14743
This is just an example of the kind of things I had in mind. I think having this as an example renders pretty well, but I guess it would also be just as fine in a notebook or even a blog post.
Happy to hear any feedback!
Rendered example