DOC add link to plot_covariance_estimation example in docstrings and userguide #30429
Conversation
There was a problem hiding this comment.
Hi @stefanogaspari,
thanks for your PR. I have added a few remarks.
In general, I think the example should only be mentioned in the docstrings of OAS and LedoitWolf, as their regularization is the topic of the example; and GridSearchCV is only used the measure their performance.
|
Hi @StefanieSenger , |
31a1a38 to
3959382
Compare
References scikit-learn#26927 What does this fix? Added links to plot_covariance_estimation example in docstrings and userguide
… in docstrings and userguide
3959382 to
e4a7eb2
Compare
|
Thank you, @stefanogaspari, that looks very good. Please go ahead removing the mention of the example in the |
Hi @StefanieSenger , good afternoon |
Oh yes, now I see. And you also need to fix the doctest issues shown in the CI. |
|
Some general information: when you go into the CI checks overview below, you find one that says "Check the rendered docs here!". In there, you can look into how the CI build the documentation for the changed files. For instance: modules/generated/sklearn.covariance.OAS.html [dev, stable] Where the first link is your branches version, the second is the main dev branch and the third link is the last releases scikit-learn version you can find on the website. It helps to check if everything went well. |
|
@StefanieSenger , all the checks have passed :) |
|
That looks pretty good! Thanks again for your contribution! 🥇 @adrinjalali, can we merge this one? |
Hello @adrinjalali, @StefanieSenger has approved this PR. Could you kindly merge it when possible? I’m currently working on another example for the Covariance chapter, and merging this would help me avoid potential conflicts. Thanks a lot! |
|
@adrinjalali I just pushed your suggested changes. |
Reference Issues/PRs
PR #26927
What does this implement/fix? Explain your changes.
Added links to plot_covariance_estimation example in docstrings and userguide