DOC: add link to the plot_mahalanobis_distances example #31485
Conversation
|
@StefanieSenger, I added link to the |
| 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.
There was a problem hiding this comment.
Thanks @virchan for reviewing my PR! I moved the link to the plot_mahalanobis_distances example into the mahalanobis method’s docstring, as you suggested. I don’t think a reference is needed in MinCovDet anymore after that.
There was a problem hiding this comment.
Thank you for updating the PR, @natmokval! I have a few more comments.
|
|
||
| Notes | ||
| ----- | ||
| For a detailed example of how outlying data affects the Mahalanobis distance, | ||
| see :ref:`sphx_glr_auto_examples_covariance_plot_mahalanobis_distances.py`. |
There was a problem hiding this comment.
Could you please place this before the "Parameters" section? Also, I think we don't need "Notes" here.
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.