Add API documentation entry for entropy
#31282
Closed
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
thomasjpfan
reviewed
May 1, 2025
There was a problem hiding this comment.
I do not know if undocumented functions were considered public.
In #30375 and sklearn/tests/test_imports_public.py, I had a dictionary that lists out all the "public" functions that are not in the api reference. Some of them are reimported, but entropy was one that was undocumented.
|
Ah yes, it doesn't look like a public public function. Let me close this and remove entropy API references in the docs instead. |
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.
Reference Issues/PRs
Noticed that
entropydoes not have a API entry in the docs (see link https://scikit-learn.org/dev/modules/array_api.html#metrics)Added it to
api_reference.py- hopefully this is all that is required?Thought about adding it to
metrics- so you can use it withsklearn.metrics.entropyand notsklearn.metrics.cluster.entropy, as we have things like "completeness_score" (which is not symmetric) undermetricsbut am not sure about this.What does this implement/fix? Explain your changes.
Any other comments?