DOC add cross-reference to examples instead of duplicating content for GPR #20003

glemaitre · 2021-04-28T21:34:25Z

follow-up #19952
closes #11562

Revamp the documentation of the Gaussian Process user guide.

TODO:

rework the example to use notebook style (done in main)
remove example from user guide
add references sections
add examples links
add potential mathematical section

jjerphan

Thanks for improving those examples @glemaitre. Those are really instructive.

Here are some suggestions from a new-comer to GPR.

doc/modules/gaussian_process.rst

examples/gaussian_process/plot_compare_gpr_krr.py

doc/modules/gaussian_process.rst

examples/gaussian_process/plot_gpr_co2.py

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

github-actions · 2023-08-02T08:58:20Z

✔️ Linting Passed

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

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

glemaitre · 2023-08-02T08:59:39Z

ping @adrinjalali

I think the following PR addresses some of your proposals discussed IRL when reviewing #26980

adrinjalali · 2023-08-03T10:04:01Z

I like the changes, but in the listed examples, we see:

And I think the second and 4th examples don't have a title which is informative enough for users to know what to expect. We should either change the title, or have a text here before referencing them so that the reader knows what they gain by reading the example.

glemaitre · 2023-08-11T22:35:56Z

I tried to improve the titles.

adrinjalali · 2023-08-24T13:33:25Z

@noashin started reviewing this I think, I'll wait for that before doing another review.

noashin · 2023-08-24T10:38:06Z

doc/modules/gaussian_process.rst

I would strongly encourage including the term NONPARAMETRIC when discussing GPs.

I would rephrase the opening (lines 9-11):
Gaussian Processes (GP) are a nonparametric supervised learning method used
to solve regression and probabilistic classification problems.

noashin · 2023-08-24T10:51:39Z

doc/modules/gaussian_process.rst

@@ -27,8 +25,8 @@ The advantages of Gaussian processes are:

 The disadvantages of Gaussian processes include:

-    - They are not sparse, i.e., they use the whole samples/features information to


Sparse Gaussian Processes is a thing, just not in Scikit. One defines a set of inducing points (smaller than the data) and use them for learning the GP instead of the data.
This is a good blog post about it.

noashin · 2023-08-24T11:29:28Z

doc/modules/gaussian_process.rst

+
+The noise level in the targets can be specified by passing it via the parameter
+`alpha`, either globally as a scalar or per datapoint. Note that a moderate
+noise level can also be helpful for dealing with numeric issues during fitting


"numerical instabilities" instead of "numerical issues" ?

glemaitre · 2023-08-29T15:10:02Z

Thanks @noashin. I added the suggestions.

adrinjalali

Are you gonna do another PR for GPC?

Otherwise LGTM.

adrinjalali · 2023-09-11T11:02:40Z

doc/modules/gaussian_process.rst

@@ -77,149 +88,12 @@ the API of standard scikit-learn estimators, GaussianProcessRegressor:
  externally for other ways of selecting hyperparameters, e.g., via
  Markov chain Monte Carlo.

+.. topic:: Examples


maybe rename to gpr_examples? we might easily conflict with another place defining an Examples topic.

This is a topic and not the name of the section. I don't think you can use this to reference.

glemaitre · 2023-09-11T11:52:00Z

Are you gonna do another PR for GPC?

Yes. It would be in the same spirit than what we did for GPR.

jjerphan

Thank you, @glemaitre.

lesteve · 2023-09-12T09:04:00Z

No idea why but one Azure build was timing out, since this is a doc PR, I merged it manually.

…r GPR (scikit-learn#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

…r GPR (#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

…r GPR (scikit-learn#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

DOC revamp documentation of GPR

a0d84a5

github-actions bot added the Documentation label Apr 28, 2021

glemaitre added 11 commits April 29, 2021 00:07

iter

286408e

iter

0383114

iter

69a984e

iter

e3f359d

Merge remote-tracking branch 'origin/main' into user_guide_gp

5cababf

remove exercise

bd281fa

iter

7de916b

iter

8e90750

iter

37d1cef

iter

d073926

iter

1a674e5

jjerphan requested changes May 19, 2021

View reviewed changes

glemaitre and others added 16 commits May 26, 2021 14:23

Apply suggestions from code review

d08a09c

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

7c2d3a6

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

83cb215

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

c965bdb

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_co2.py

a20e370

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_co2.py

9bedda0

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_co2.py

a2e4057

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_co2.py

76a4a11

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

d0a4396

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Apply suggestions from code review

e1467af

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

e0b5422

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_compare_gpr_krr.py

41a8b2e

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Apply suggestions from code review

7cfc324

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_noisy_targets.py

8d5a356

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_noisy_targets.py

2329354

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Update examples/gaussian_process/plot_gpr_noisy_targets.py

49db719

Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Merge remote-tracking branch 'origin/main' into user_guide_gp

da32d5e

glemaitre changed the title ~~[NOMRG] DOC revamp documentation of GPR~~ DOC revamp documentation of GPR Nov 3, 2021

glemaitre added 2 commits August 2, 2023 10:56

Merge remote-tracking branch 'origin/main' into user_guide_gp

5677f19

forgot to save

bd8bb62

glemaitre marked this pull request as ready for review August 2, 2023 08:58

glemaitre changed the title ~~DOC revamp documentation of GPR~~ DOC add cross-reference to examples instead of duplicating content for GPR Aug 2, 2023

glemaitre added 2 commits August 12, 2023 00:33

Merge remote-tracking branch 'origin/main' into user_guide_gp

a547d34

improve title

87c9272

noashin reviewed Aug 29, 2023

View reviewed changes

glemaitre added 2 commits August 29, 2023 17:06

Merge remote-tracking branch 'origin/main' into user_guide_gp

45bfb48

add changes proposed by Noa

53b2eda

adrinjalali reviewed Sep 11, 2023

View reviewed changes

adrinjalali approved these changes Sep 11, 2023

View reviewed changes

adrinjalali requested a review from jjerphan September 11, 2023 13:15

Merge branch 'main' into user_guide_gp

b06bdca

jjerphan approved these changes Sep 11, 2023

View reviewed changes

jjerphan enabled auto-merge (squash) September 11, 2023 14:05

lesteve disabled auto-merge September 12, 2023 09:03

lesteve merged commit 0684a89 into scikit-learn:main Sep 12, 2023

glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 18, 2023

DOC add cross-reference to examples instead of duplicating content fo…

206120e

…r GPR (scikit-learn#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

jeremiedbb pushed a commit that referenced this pull request Sep 20, 2023

DOC add cross-reference to examples instead of duplicating content fo…

267aa66

…r GPR (#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023

DOC add cross-reference to examples instead of duplicating content fo…

a74d60a

…r GPR (scikit-learn#20003) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC add cross-reference to examples instead of duplicating content for GPR #20003

DOC add cross-reference to examples instead of duplicating content for GPR #20003

glemaitre commented Apr 28, 2021 •

edited

Loading

jjerphan left a comment

github-actions bot commented Aug 2, 2023 •

edited

Loading

glemaitre commented Aug 2, 2023

adrinjalali commented Aug 3, 2023

glemaitre commented Aug 11, 2023

adrinjalali commented Aug 24, 2023

noashin Aug 24, 2023

noashin Aug 24, 2023

noashin Aug 24, 2023

glemaitre commented Aug 29, 2023

adrinjalali left a comment

adrinjalali Sep 11, 2023

glemaitre Sep 11, 2023

glemaitre commented Sep 11, 2023

jjerphan left a comment

lesteve commented Sep 12, 2023

		@@ -27,8 +25,8 @@ The advantages of Gaussian processes are:

		The disadvantages of Gaussian processes include:

		- They are not sparse, i.e., they use the whole samples/features information to

DOC add cross-reference to examples instead of duplicating content for GPR #20003

DOC add cross-reference to examples instead of duplicating content for GPR #20003

Conversation

glemaitre commented Apr 28, 2021 • edited Loading

jjerphan left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 2, 2023 • edited Loading

✔️ Linting Passed

glemaitre commented Aug 2, 2023

adrinjalali commented Aug 3, 2023

glemaitre commented Aug 11, 2023

adrinjalali commented Aug 24, 2023

noashin Aug 24, 2023

Choose a reason for hiding this comment

noashin Aug 24, 2023

Choose a reason for hiding this comment

noashin Aug 24, 2023

Choose a reason for hiding this comment

glemaitre commented Aug 29, 2023

adrinjalali left a comment

Choose a reason for hiding this comment

adrinjalali Sep 11, 2023

Choose a reason for hiding this comment

glemaitre Sep 11, 2023

Choose a reason for hiding this comment

glemaitre commented Sep 11, 2023

jjerphan left a comment

Choose a reason for hiding this comment

lesteve commented Sep 12, 2023

glemaitre commented Apr 28, 2021 •

edited

Loading

github-actions bot commented Aug 2, 2023 •

edited

Loading