DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py #30749

Siniade · Feb 2, 2025

Reference Issues/PRs

Towards #30621 - Linked examples for plot_gradient_boosting_categorical.py, plot_gradient_boosting_oob.py, and plot_gradient_boosting_regularization.py from examples/ensemble.

What does this implement/fix? Explain your changes.

plot_gradient_boosting_categorical.py

Added description to the API documentation in sklearn.ensemble.HistGradientBoostingRegressor
No changes to User Guide - already well referenced under 1.11.1.1.4

plot_gradient_boosting_oob.py

Added description to the API documentation in sklearn.ensemble.GradientBoostingClassifier
No changes to User Guide - already well referenced under 1.11.1.2 & 1.11.1.2.6

plot_gradient_boosting_regularization.py

Added description to the API documentation in sklearn.ensemble.GradientBoostingClassifier & sklearn.ensemble.GradientBoostingRegressor
Referenced under Examples in 1.11.1.2.6. Added a link to the example in the text under 1.11.1.2.5.

Any other comments?

github-actions · Feb 2, 2025

✔️ Linting Passed

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

_{Generated for commit: d95548d. Link to the linter CI: here}

virchan

Thank you for the PR @Siniade!

I have a few comments:

virchan · Feb 4, 2025

sklearn/ensemble/_gb.py

+    See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
+    for an example on using regularization with Gradient Boosting.
+


I don't think we need this example here since the linked resource is about classifiers, whereas the docstring refers to a regressor. The relevant example is already covered by plot_gradient_boosting_regression.py, which is included in the docstring of GradientBoostingRegressor.

virchan · Feb 4, 2025

sklearn/ensemble/_gb.py

+    See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_oob.py` for
+    an example on using Out-of-Bag estimates to estimate the optimal number of
+    iterations for Gradient Boosting.
+    See
+    :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
+    for an example on using regularization with Gradient Boosting.
+


Could you please move these two examples to the end of the docstring? You can refer to how plot_gradient_boosting_regression.py is placed in the GradientBoostingRegressor docstring.

virchan · Feb 4, 2025

sklearn/ensemble/_hist_gradient_boosting/gradient_boosting.py

    See :ref:`sphx_glr_auto_examples_ensemble_plot_hgbt_regression.py` for a
-    usecase example of this feature.
+    usecase example of this feature. See
+    :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_categorical.py`
+    for an example using histogram-based gradient boosting on categorical features.


Would you mind placing these two examples at the end of the docstring? You can follow the placement of plot_gradient_boosting_regression.py in the GradientBoostingRegressor docstring as a reference.

Sure. The first example was already present and is related to the paragraph that precedes it. Do you want me to move the first examples also in that case or should I let that be?

Thanks for the catch! You can leave the first example where it is.

Siniade · Feb 4, 2025

Thank you for the PR @Siniade!

I have a few comments:

Thanks for your suggestions! I have made the updates

virchan

Thank you for updating the PR @Siniade!

I have a few more comments.

virchan · Feb 5, 2025

sklearn/ensemble/_gb.py

+    iterations for Gradient Boosting. For a detailed example of utilizing
+    regularization with
+    :class:`~sklearn.ensemble.GradientBoostingClassifier`, please refer to
+    :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`.


Could you please separate this example into a new paragraph?

virchan · Feb 5, 2025

doc/modules/ensemble.rst

+``learning_rate`` and ``n_estimators`` see [R2007]_. Also see :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
+for an example on how regularization via shrinkage impacts Gradient Boosting.


Could you please move

"Also see :ref:sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py"

to the next line?

Sure. I have committed the updated changes.

virchan

LGTM! Thanks @Siniade!

@adrinjalali, @marenwestermann, would you like to take a look and merge it?

adrinjalali

I've applied my comments directly here. Thanks for the PR @Siniade

adrinjalali · Feb 12, 2025

doc/modules/ensemble.rst

+Also see :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
+for an example on how regularization via shrinkage impacts Gradient Boosting.


already mentioned in the next section, so removing

adrinjalali · Feb 12, 2025

sklearn/ensemble/_gb.py

+    For a detailed example of utilizing regularization with
+    :class:`~sklearn.ensemble.GradientBoostingClassifier`, please refer to
+    :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`.


moving this to the parameter docstring

adrinjalali · Feb 12, 2025

sklearn/ensemble/_gb.py

+    See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_oob.py` for
+    an example on using Out-of-Bag estimates to estimate the optimal number of
+    iterations for Gradient Boosting.


this example is linked from the user guide, and needs improvements, then we can think of adding it in the docstring, so removing it from here

adrinjalali · Feb 12, 2025

sklearn/ensemble/_hist_gradient_boosting/gradient_boosting.py

+    See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_categorical.py`
+    for an example using histogram-based gradient boosting on categorical features.


moving to the parameter's docstring.

github-actions bot added the module:ensemble label Feb 2, 2025

virchan reviewed Feb 4, 2025

View reviewed changes

StefanieSenger mentioned this pull request Feb 4, 2025

Add links to examples from the docstrings and user guide #30621

Open

virchan reviewed Feb 5, 2025

View reviewed changes

Siniade added 2 commits February 5, 2025 19:16

Linked 3 examples to the User Guide and API documentation

c3f7f60

Modify linked examples as per suggestions

d2e04e0

Siniade force-pushed the link-to-example branch from 1b85e0a to d2e04e0 Compare February 6, 2025 00:16

Move examples to new line

97697f5

virchan approved these changes Feb 7, 2025

View reviewed changes

adrinjalali added 2 commits February 12, 2025 16:46

move examples

94fb5ed

Merge remote-tracking branch 'upstream/main' into link-to-example

d95548d

adrinjalali approved these changes Feb 12, 2025

View reviewed changes

adrinjalali changed the title ~~Linked 3 examples to the User Guide and API documentation~~ DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py Feb 12, 2025

github-actions bot added the Documentation label Feb 12, 2025

adrinjalali enabled auto-merge (squash) February 12, 2025 15:57

adrinjalali merged commit f93ff1b into scikit-learn:main Feb 12, 2025
34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py #30749

DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py #30749

Siniade commented Feb 2, 2025

github-actions bot commented Feb 2, 2025 •

edited

Loading

virchan left a comment

virchan Feb 4, 2025

virchan Feb 4, 2025

virchan Feb 4, 2025

Siniade Feb 4, 2025

virchan Feb 4, 2025

Siniade commented Feb 4, 2025

virchan left a comment

virchan Feb 5, 2025

virchan Feb 5, 2025

Siniade Feb 6, 2025

virchan left a comment

adrinjalali left a comment

adrinjalali Feb 12, 2025

adrinjalali Feb 12, 2025

adrinjalali Feb 12, 2025

adrinjalali Feb 12, 2025

		See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
		for an example on using regularization with Gradient Boosting.

		``learning_rate`` and ``n_estimators`` see [R2007]_. Also see :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
		for an example on how regularization via shrinkage impacts Gradient Boosting.

		Also see :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_regularization.py`
		for an example on how regularization via shrinkage impacts Gradient Boosting.

		See :ref:`sphx_glr_auto_examples_ensemble_plot_gradient_boosting_categorical.py`
		for an example using histogram-based gradient boosting on categorical features.

Search code, repositories, users, issues, pull requests...

DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py #30749

DOC added links to plot_gradient_boosting_regularization.py and plot_gradient_boosting_categorical.py #30749

Conversation

Siniade commented Feb 2, 2025

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

github-actions bot commented Feb 2, 2025 • edited Loading

✔️ Linting Passed

virchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Siniade commented Feb 4, 2025

virchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

virchan left a comment

Choose a reason for hiding this comment

adrinjalali left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 2, 2025 •

edited

Loading