DOC Ensures that shrunk_covariance passes numpydoc validation#22260
DOC Ensures that shrunk_covariance passes numpydoc validation#22260glemaitre merged 9 commits intoscikit-learn:mainfrom
Conversation
|
Thanks @purnachandramansingh. If you want to improve the documentation a little bit more (in my opinion ^^), we can change this too: """
Notes
-----
The regularized (shrunk) covariance is given by::
(1 - shrinkage) * cov + shrinkage * mu * np.identity(n_features)
where `mu = trace(cov) / n_features`.
""" |
|
Thanks for your suggestions @jmloyola. |
|
Great!. Now, let's wait for more reviewers. |
|
Thanks, @jmloyola I just wanted to know how did you generate this document as shown in the above image. |
|
I built the documentation following the Contributing page |
Thanks, @jmloyola, I will follow the same. |
|
Hi @jmloyola, could you please guide me on how to resolve these conflicts. |
|
You probably have to merge the new commits done to the main branch. |
|
ok got it, Thanks |
thomasjpfan
left a comment
There was a problem hiding this comment.
Thanks for the PR @purnachandramansingh !
Can you remove the line here:
to make sure the test pass?
(Also you may need to sync with main to make sure the test runs correctly)
|
my bad!!, initially I removed this line but I think during my last sync It get replaced. |
done @thomasjpfan, please have a look. |
|
LGTM |

Reference Issues/PRs
Addresses #21350
What does this implement/fix? Explain your changes.
This PR fixes the following errors that were appearing for numpydoc validation for sklearn.covariance._shrunk_covariance.shrunk_covariance
Any other comments?
Thanks