-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
MNT Move entropy
to private function
#31294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Indded it's a private function that was never documented. Can you take the opportunity of this PR to remove param validation from this function and making it explicitely private with a leading underscore ? |
entropy
to private function
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm +1 to rename it with the leading underscore without deprecation since it was not documented.
However, the fact that it was exposed in the plublic sklearn.metrics.cluster
namespace and had param validation suggests that it was unclear for us that it really was a private function. So I'd understand if others would rather go with a deprecation. Let's wait for more opinions.
LGTM otherwise |
Reference Issues/PRs
Related to #31282
What does this implement/fix? Explain your changes.
entropy
is not a API documented function (on purpose) so removing reference to it.Any other comments?
cc @thomasjpfan