Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
Loading
from

Conversation

lucyleeow
Copy link
Member

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

Copy link

github-actions bot commented May 2, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 160ea9f. Link to the linter CI: here

@jeremiedbb
Copy link
Member

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 ?

@lucyleeow lucyleeow changed the title DOC Remove reference to entropy API MNT Move entropy to private function May 7, 2025
Copy link
Member

@jeremiedbb jeremiedbb left a 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.

sklearn/metrics/cluster/__init__.py Outdated Show resolved Hide resolved
@jeremiedbb
Copy link
Member

LGTM otherwise

@lucyleeow lucyleeow added the Needs Decision Requires decision label May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.