Skip to content

DOC Add link to plot_gmm_pdf.py in GaussianMixture examples#31230

Merged
marenwestermann merged 6 commits intoscikit-learn:mainfrom
vivaannanavati123:addingLinks
Nov 15, 2025
Merged

DOC Add link to plot_gmm_pdf.py in GaussianMixture examples#31230
marenwestermann merged 6 commits intoscikit-learn:mainfrom
vivaannanavati123:addingLinks

Conversation

@vivaannanavati123
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Addresses #30621.

What does this implement/fix? Explain your changes.

  • Added link to plot_gmm_pdf.py in GaussianMixture docstring examples to demonstrate density estimation, a key GMM use case missing in API docs.
  • No duplicates found for plot_gmm_pdf.py in API docs.
  • Local doc build confirmed link validity.

Any other comments?

Noticed that plot_roc_crossval.py is already linked in User Guide sections (model_evaluation.rst, cross_validation.rst) and related examples, so I would recommend for it to be checked off.

Thank you for your review!

Vivaan Nanavati added 3 commits April 20, 2025 15:30
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 20, 2025

✔️ Linting Passed

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

Generated for commit: a5c550d. 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.

Hi @vivaannanavati123,

thank you for your contribution. I would suggest a change in phrasing, to express what is special about this example compared to other examples on GaussianMixture.

Maybe move the link inside the docstring of the score_samples method in sklearn/mixture/_base.py, which is displayed both in GaussianMixture as well as in BaysianGaussianMixture, though it might be worth it. What do you think?

Comment on lines +707 to +709
Gaussian Mixture Models are commonly used for probability density estimation and
modeling multi-modal distributions. For a visualization, see
:ref:`sphx_glr_auto_examples_mixture_plot_gmm_pdf.py`
Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger Apr 28, 2025

Choose a reason for hiding this comment

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

I would suggest to directly describe what the example shows. Maybe like this:

Suggested change
Gaussian Mixture Models are commonly used for probability density estimation and
modeling multi-modal distributions. For a visualization, see
:ref:`sphx_glr_auto_examples_mixture_plot_gmm_pdf.py`
For an illustration of the negative log-likelihood surface of a
:class:`~sklearn.mixture.GaussianMixture` Model,
see :ref:`sphx_glr_auto_examples_mixture_plot_gmm_pdf.py`.

@StefanieSenger
Copy link
Copy Markdown
Member

Hi @vivaannanavati123, are you still interested in working on that?

@lucyleeow
Copy link
Copy Markdown
Member

I am going to close this due to inactivity and because we have decided to close the issue #30621.

@lucyleeow lucyleeow closed this Sep 8, 2025
@lucyleeow
Copy link
Copy Markdown
Member

Re-opening, as this was reviewed and someone else may wish to continue

@lucyleeow lucyleeow reopened this Sep 8, 2025
Copy link
Copy Markdown
Member

@marenwestermann marenwestermann left a comment

Choose a reason for hiding this comment

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

This PR should have been closed straight away as it very much looks AI generated. However, I didn't want @StefanieSenger's work go to waste. I will merge when the CI is green.

@marenwestermann marenwestermann enabled auto-merge (squash) November 15, 2025 09:14
@marenwestermann marenwestermann merged commit 5a07bfc into scikit-learn:main Nov 15, 2025
38 checks passed
@vivaannanavati123 vivaannanavati123 deleted the addingLinks branch November 16, 2025 20:41
virchan pushed a commit to virchan/scikit-learn that referenced this pull request Nov 17, 2025
Co-authored-by: Vivaan Nanavati <vivaan@Vivaans-MacBook-Pro.local>
Co-authored-by: Maren Westermann <maren.westermann@gmail.com>
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.

4 participants