DOC: add link to the plot_mahalanobis_distances example #31485
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@StefanieSenger, I added link the to |
virchan
reviewed
Jun 11, 2025
Comment on lines
+140
to
+142
| For an example of using covariance estimation with Mahalanobis | ||
| distances on Gaussian distributed data, refer to | ||
| :ref:`sphx_glr_auto_examples_covariance_plot_mahalanobis_distances.py` |
There was a problem hiding this comment.
I think it'd be better idea to place this inside the mahalanobis method's docstring. Also,
"For a detailed example of how outlying data affects the Mahalanobis distance, see <example_link>."
The same applies to MinCovDet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Towards #30621
This PR adds a reference to the
plot_mahalanobis_distances.py.The
plot_mahalanobis_distances.pyexample is already referenced in the User Guide. I added a link to make the example visible from the API documentation as well.