DOC Ensures that sklearn.utils.extmath.fast_logdet passes numpydoc validation#24605
Conversation
sklearn.utils.extmath.fast_logdet passes numpydoc validation
|
Thanks for the PR @awinml. I directly pushed some changes because this is now the last function to deal with, so we can clean-up the filtering in the test at the same time. I also simplified a bit some parts, especially the example: we usually keep the example simple and don't include special cases. |
|
That's good @jeremiedbb.
|
We don't have the need for that in scikit-learn so far so I don't see the benefit. |
…lidation (scikit-learn#24605) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr>
Reference Issues/PRs
Addresses #21350
Ensures that
sklearn.utils.extmath.fast_logdetpasses numpydoc validation.What does this implement/fix? Explain your changes.
sklearn.utils.extmath.fast_logdetfromtest_docstrings.pynumpy.linalg.slogdet.Any other comments?
A limitation of this function as compared to
numpy.linalg.slogdetis that it cannot broadcast for multiple matrices in a single function call.When we pass a stack of matrices as input it throws a ValueError.
Ex:
I could work on this issue if required.