Skip to content

DOC Linked examples for LDA and QDA in their docstrings (#26927) #28611

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

Merged
merged 5 commits into from
Mar 14, 2024

Conversation

jpienaar-tuks
Copy link
Contributor

Reference Issues/PRs

Adds links to examples/classification mentioned in #26927

What does this implement/fix? Explain your changes.

Adds links to auto-generated examples for classes LinearDiscriminantAnalysis and QuadraticDiscriminantAnalysis

Any other comments?

Examples linked:

  • examples/classification
    • plot_lda.py
    • plot_lda_qda.py
  • examples/decomposition
    • plot_pca_vs_lda.py

Copy link

github-actions bot commented Mar 11, 2024

✔️ Linting Passed

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

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

@@ -222,6 +226,9 @@ class LinearDiscriminantAnalysis(
This should be left to None if `covariance_estimator` is used.
Note that shrinkage works only with 'lsqr' and 'eigen' solvers.

For an example usage, see
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For an example usage, see
For a usage example, see

I'd rewrite this like this

@@ -232,6 +239,9 @@ class LinearDiscriminantAnalysis(
min(n_classes - 1, n_features). This parameter only affects the
`transform` method.

For an example usage for dimensionality reduction, see
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For an example usage for dimensionality reduction, see
For a usage example, see

I'd rewrite this like this

Copy link
Member

@betatim betatim 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 helping make the examples easier to find!

Looks good to me, besides the two suggestions I made.

@jpienaar-tuks
Copy link
Contributor Author

Thank you for the feedback. I've made the updates.

@glemaitre glemaitre self-requested a review March 14, 2024 17:40
@glemaitre glemaitre enabled auto-merge (squash) March 14, 2024 18:07
@glemaitre glemaitre merged commit 082b588 into scikit-learn:main Mar 14, 2024
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