Added info and links to mixture examples for the GaussianMixture and BayesianGaussianMixture classes #30420

janeBrusilovsky · 2024-12-06T23:40:30Z

Reference Issues/PRs

This PR contributes towards issue #26927: Add links to examples from the docstrings and user guides. https://github.com/scikit-learn/scikit-learn/issues/26927

What does this implement/fix? Explain your changes.

This PR adds information and example links to the class GaussianMixture in sklearn/mixture/_gaussian_mixture.py from:

examples/mixture/plot_gmm_init.py
examples/mixture/plot_gmm_selection.py
examples/mixture/plot_gmm_covariances.py

This PR also adds information and example links to the class BayesianGaussianMixture in sklearn/mixture/_bayesian_mixture.py from examples/mixture/plot_concentration_prior.py.

Any other comments?

Files modified:

sklearn/mixture/_gaussian_mixture.py
sklearn/mixture/_bayesian_mixture.py

github-actions · 2024-12-06T23:41:46Z

❌ Linting issues

This PR is introducing linting issues. Here's a summary of the issues. Note that you can avoid having linting issues by enabling pre-commit hooks. Instructions to enable them can be found here.

You can see the details of the linting issues under the lint job here

`ruff`

ruff detected issues. Please run ruff check --fix --output-format=full . locally, fix the remaining issues, and push the changes. Here you can see the detected issues. Note that the installed ruff version is ruff=0.5.1.


sklearn/mixture/_bayesian_mixture.py:92:80: W291 Trailing whitespace
   |
90 |     Read more in the :ref:`User Guide <bgmm>`.
91 | 
92 |     For a detailed example of how the weight_concentration_prior_type parameter 
   |                                                                                ^ W291
93 |     influences the model's behaviour, please refer to:
94 |     :ref:`sphx_glr_auto_examples_mixture_plot_concentration_prior.py`
   |
   = help: Remove trailing whitespace

sklearn/mixture/_gaussian_mixture.py:517:68: W291 Trailing whitespace
    |
515 |     Read more in the :ref:`User Guide <gmm>`.
516 | 
517 |     For a detailed example of how the init_params parameter impacts 
    |                                                                    ^ W291
518 |     the model's convergence behaviour, refer to:
519 |     :ref:`sphx_glr_auto_examples_mixture_plot_gmm_init.py`
    |
    = help: Remove trailing whitespace

sklearn/mixture/_gaussian_mixture.py:525:64: W291 Trailing whitespace
    |
523 |     :ref:`sphx_glr_auto_examples_mixture_plot_gmm_selection.py`
524 | 
525 |     For a detailed example of how the covariance_type parameter 
    |                                                                ^ W291
526 |     impacts the model's performance, refer to:
527 |     :ref:`sphx_glr_auto_examples_mixture_plot_gmm_covariances.py`
    |
    = help: Remove trailing whitespace

Found 3 errors.
No fixes available (3 hidden fixes can be enabled with the `--unsafe-fixes` option).

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

virchan

Thank you for the PR @janeBrusilovsky! I have a few suggestions.

virchan · 2024-12-08T02:02:24Z

sklearn/mixture/_bayesian_mixture.py

+    For examples on how to implement the class model, please refer to:
+    :ref:`sphx_glr_auto_examples_mixture_plot_concentration_prior.py`


I suggest to phrase it as:

"For a detailed example of how the weight_concentration_prior_type parameter influences the model's behaviour, see <example_link>."

virchan · 2024-12-08T02:02:30Z

sklearn/mixture/_gaussian_mixture.py

+    For examples on different methods of initialization, refer to:
+    :ref:`sphx_glr_auto_examples_mixture_plot_gmm_init.py`


"For a detailed example of how the init_params parameter impacts the model's convergence behaviour, see <example_link>."

virchan · 2024-12-08T02:02:42Z

sklearn/mixture/_gaussian_mixture.py

+    For examples on model selection with Gassian Mixture, refer to:
+    :ref:`sphx_glr_auto_examples_mixture_plot_gmm_selection.py`


"For a detailed example of how the n_components and covariance_type parameters influence the model's performance, see <example_link>."

virchan · 2024-12-08T02:02:46Z

sklearn/mixture/_gaussian_mixture.py

+    For example covariances types for Gaussian mixture models, see:
+    :ref:`sphx_glr_auto_examples_mixture_plot_gmm_covariances.py`


"For a detailed example of how the covariance_type parameter impacts the model's performance, see <example_link>."

janeBrusilovsky · 2024-12-10T05:12:08Z

I've updated the wording to match the suggestions. Thanks for the feedback!

StefanieSenger · 2024-12-10T12:07:41Z

Hi, @janeBrusilovsky!

Now you have to fix the linting issue.

Have you installed pre-commit, as recommended in the developer guide? It helps with issues like this one.

pip install pre-commit
pre-commit install

virchan

Thank you for the updates, @janeBrusilovsky! In addition to @StefanieSenger's comment, you can click on details under ci/circleci: lint in the code checks to view the error messages.

virchan · 2024-12-10T18:59:17Z

sklearn/mixture/_bayesian_mixture.py

@@ -89,6 +89,10 @@ class BayesianGaussianMixture(BaseMixture):

    Read more in the :ref:`User Guide <bgmm>`.

+    For a detailed example of how the weight_concentration_prior_type parameter 


Suggested change

For a detailed example of how the weight_concentration_prior_type parameter

For a detailed example of how the `weight_concentration_prior_type` parameter

virchan · 2024-12-10T18:59:38Z

sklearn/mixture/_gaussian_mixture.py

@@ -514,6 +514,18 @@ class GaussianMixture(BaseMixture):

    Read more in the :ref:`User Guide <gmm>`.

+    For a detailed example of how the init_params parameter impacts 


Suggested change

For a detailed example of how the init_params parameter impacts

For a detailed example of how the `init_params` parameter impacts

virchan · 2024-12-10T19:00:05Z

sklearn/mixture/_gaussian_mixture.py

+    For a detailed example of how the n_components and covariance_type
+    parameters influence the model's performance, refer to:


Suggested change

For a detailed example of how the n_components and covariance_type

parameters influence the model's performance, refer to:

For a detailed example of how the `n_components` and `covariance_type`

parameters influence the model's performance, refer to:

virchan · 2024-12-10T19:00:23Z

sklearn/mixture/_gaussian_mixture.py

+    parameters influence the model's performance, refer to:
+    :ref:`sphx_glr_auto_examples_mixture_plot_gmm_selection.py`
+
+    For a detailed example of how the covariance_type parameter 


Suggested change

For a detailed example of how the covariance_type parameter

For a detailed example of how the `covariance_type` parameter

janeBrusilovsky added 4 commits December 6, 2024 13:59

added plot_concentration_prior example to _bayesian_mixture

9bbbf31

added plot_gmm_init example to _gaussian_mixture

ab67ca0

added plot_gmm_slection example to _gaussian_mixture

9e412ba

added plot_gmm_covariances example to _gaussian_mixture

bb2a211

github-actions bot added the module:mixture label Dec 6, 2024

janeBrusilovsky mentioned this pull request Dec 6, 2024

Add links to examples from the docstrings and user guides #26927

Open

virchan reviewed Dec 8, 2024

View reviewed changes

janeBrusilovsky added 2 commits December 9, 2024 21:08

Updated plot_concentration_prior example wording

fb61c04

Updated example wording

f8cbdad

virchan reviewed Dec 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added info and links to mixture examples for the GaussianMixture and BayesianGaussianMixture classes #30420

Added info and links to mixture examples for the GaussianMixture and BayesianGaussianMixture classes #30420

janeBrusilovsky commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

virchan left a comment

virchan Dec 8, 2024

virchan Dec 8, 2024

virchan Dec 8, 2024

virchan Dec 8, 2024

janeBrusilovsky commented Dec 10, 2024

StefanieSenger commented Dec 10, 2024

virchan left a comment

virchan Dec 10, 2024

virchan Dec 10, 2024

virchan Dec 10, 2024

virchan Dec 10, 2024

		For examples on how to implement the class model, please refer to:
		:ref:`sphx_glr_auto_examples_mixture_plot_concentration_prior.py`

		For examples on different methods of initialization, refer to:
		:ref:`sphx_glr_auto_examples_mixture_plot_gmm_init.py`

		For examples on model selection with Gassian Mixture, refer to:
		:ref:`sphx_glr_auto_examples_mixture_plot_gmm_selection.py`

		For example covariances types for Gaussian mixture models, see:
		:ref:`sphx_glr_auto_examples_mixture_plot_gmm_covariances.py`

		@@ -89,6 +89,10 @@ class BayesianGaussianMixture(BaseMixture):

		Read more in the :ref:`User Guide <bgmm>`.

		For a detailed example of how the weight_concentration_prior_type parameter

	For a detailed example of how the weight_concentration_prior_type parameter
	For a detailed example of how the `weight_concentration_prior_type` parameter

		@@ -514,6 +514,18 @@ class GaussianMixture(BaseMixture):

		Read more in the :ref:`User Guide <gmm>`.

		For a detailed example of how the init_params parameter impacts

	For a detailed example of how the init_params parameter impacts
	For a detailed example of how the `init_params` parameter impacts

		For a detailed example of how the n_components and covariance_type
		parameters influence the model's performance, refer to:

	For a detailed example of how the covariance_type parameter
	For a detailed example of how the `covariance_type` parameter

Added info and links to mixture examples for the GaussianMixture and BayesianGaussianMixture classes #30420

Are you sure you want to change the base?

Added info and links to mixture examples for the GaussianMixture and BayesianGaussianMixture classes #30420

Conversation

janeBrusilovsky commented Dec 6, 2024 • edited Loading

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

github-actions bot commented Dec 6, 2024 • edited Loading

❌ Linting issues

ruff

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

janeBrusilovsky commented Dec 10, 2024

StefanieSenger commented Dec 10, 2024

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

janeBrusilovsky commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

`ruff`