Skip to content

DOC add link to plot_gpr_on_structured_data example in gaussian_process#31150

Merged
adrinjalali merged 6 commits intoscikit-learn:mainfrom
ashbleu:doc_gpr
May 6, 2025
Merged

DOC add link to plot_gpr_on_structured_data example in gaussian_process#31150
adrinjalali merged 6 commits intoscikit-learn:mainfrom
ashbleu:doc_gpr

Conversation

@ashbleu
Copy link
Copy Markdown
Contributor

@ashbleu ashbleu commented Apr 5, 2025

Reference Issues/PRs

Towards #30621.

What does this implement/fix? Explain your changes.

Added link to the plot_gpr_on_structured_data example in the Gaussian Process Regression section of gaussian_process in the User Guide, since it isn't currently linked anywhere on that page.

Any other comments?

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 5, 2025

✔️ Linting Passed

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

Generated for commit: f4c1cb9. Link to the linter CI: here

Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

Hello @ashbleu,

thank you for opening this PR.

You have identified that this example is hard to discover (currently there is no link to it anywhere in the docs).

Instead of adding the link as a 5th link line in Examples, I would suggest to instead integrate it in the section about kernels in the user guide, here: https://scikit-learn.org/stable/modules/gaussian_process.html#gp-kernels.

  • as a sentence
  • pointing out the example's demonstration on how to design a custom kernel for discrete data

Would you mind going back to make this change?

@ashbleu
Copy link
Copy Markdown
Contributor Author

ashbleu commented Apr 12, 2025

Hi @StefanieSenger,

I have added a sentence about the example in the Kernels section, and removed it from the list of links in Examples. Please let me know if you have any other suggestions!

Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

Thanks for your work, @ashbleu!

That looks very good. The sentence is in the right spot I would think and everything renders correctly. The CI failures are just http request errors and should go away if you re-trigger the CI by pushing an empty commit.

Would you like to take a look at this PR, @adrinjalali ?

@adrinjalali adrinjalali merged commit f29c100 into scikit-learn:main May 6, 2025
36 checks passed
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.

3 participants