Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 614: [DOCS] Add bayesian methods to GMM density page #642

Merged
merged 4 commits into from
Mar 23, 2024

Conversation

mkalimeri
Copy link
Contributor

Fixes issue #614: [DOCS] Add bayesian methods to GMM density pageAdded a line mentioning the available models

Before working on a large PR, please check with @koaning or @MBrouns that they agree with the direction of the PR. This discussion should take place in a Github issue before working on the PR, unless it's a minor change like spelling in the docs.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the style guidelines (flake8)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (also to the readme.md)
  • I have added tests that prove my fix is effective or that my feature works
  • I have added tests to check whether the new feature adheres to the sklearn convention
  • New and existing unit tests pass locally with my changes

If you feel your PR is ready for a review, ping @koaning or @MBrouns.

@@ -4,7 +4,7 @@ Gaussian Mixture Models (GMMs) are flexible building blocks for other machine le

This is in part because they are great approximations for general probability distributions but also because they remain somewhat interpretable even when the dataset gets very complex.

This package makes use of GMMs to construct other algorithms.
This package makes use of GMMs to construct other algorithms. Bayesian [BayesianGMMClassifier][bayes_gmm-classifier-api] and non-Bayesian Gaussian Mixture Models [GMMClassifier][gmm-classifier-api] are available.
Copy link
Owner

Choose a reason for hiding this comment

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

I might rephrase this slightly because at this point in the docs folks are already aware of the normal GMMClassifier.

Maybe something like "In addition to the GMMClassifier this library also features a Bayesian variant. More information can be found here"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated!

Copy link
Owner

@koaning koaning left a comment

Choose a reason for hiding this comment

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

Minor change.

@mkalimeri
Copy link
Contributor Author

Updated, thank you!

@FBruzzesi
Copy link
Collaborator

FBruzzesi commented Mar 23, 2024

I think it would make sense to mention BayesianGMMOutlierDetector as well for the outlier side

@koaning koaning merged commit 79e39f3 into koaning:main Mar 23, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants