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
DOC Point GradientBoosting towards HistGradientBoosting #23340
Conversation
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.
Thanks for the PR. I think we should avoid the "GB" acronym and rather be explicit at the cost of a bit of redundancy.
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.
A few more suggestions but LGTM.
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
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.
Thank you for cross-referencing the HGBT interfaces, @ArturoAmorQ.
I think the terminology can be made a bit more precise, for instance by replacing "estimator" by "algorithm". Here are a few comments in this regard.
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
…nto GBDT_to_HGBDT
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.
LGTM. Thank you, @ArturoAmorQ!
…#23340) * Point GradientBoosting towards HistGradientBoosting on docstrings * Point GradientBoosting towards HistGradientBoosting on examples * Avoid the GB acronym * Iter * Apply suggestion from lesteve * Apply suggestions from code review Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * Format * Apply suggestions from code review Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * Format Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
* Point GradientBoosting towards HistGradientBoosting on docstrings * Point GradientBoosting towards HistGradientBoosting on examples * Avoid the GB acronym * Iter * Apply suggestion from lesteve * Apply suggestions from code review Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * Format * Apply suggestions from code review Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * Format Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
…#23340) * Point GradientBoosting towards HistGradientBoosting on docstrings * Point GradientBoosting towards HistGradientBoosting on examples * Avoid the GB acronym * Iter * Apply suggestion from lesteve * Apply suggestions from code review Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * Format * Apply suggestions from code review Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * Format Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
Reference Issues/PRs
Addresses #23231.
What does this implement/fix? Explain your changes.
People may use
GradientBoosting*
in cases whereHistGradientBoosting*
would perform better.This PR addresses the problem by adding references towards the Hist versions in the docstrings and examples.
Any other comments?
This is a quick fix as suggested by this comment.
Reworking the examples (as mentioned in this comment) or adding an additional example (as mentioned here) is left for another PR.