8000 Beta-divergence example promotes the usage of a non-public API · Issue #21402 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content
8000

Beta-divergence example promotes the usage of a non-public API #21402

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.

Sign up for GitHub

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

Jump to bottom
Closed
chkoar opened this issue Oct 22, 2021 · 3 comments · Fixed by #25801
Closed

Beta-divergence example promotes the usage of a non-public API #21402

chkoar opened this issue Oct 22, 2021 · 3 comments · Fixed by #25801
Labels
Documentation help wanted module:decomposition

Comments

@chkoar
Copy link
Contributor
chkoar commented Oct 22, 2021 •
edited
Loading

The Beta-divergence loss functions example promotes the usage of a non-public function from a non-public module.

from sklearn.decomposition._nmf import _beta_divergence

Having this example in the gallery the users might think that they are encouraged to import from an internal API.

Potential fixes:

Consider the aforementioned function as public API. That means that the function should be renamed and imported from a public module.

or

Remove the example.
@TomDLT
Copy link
Member
TomDLT commented Oct 22, 2021

I agree. I am fine with both options, with a slight preference for making the function public. The function is already well documented and tested.

< 8000 /div>
@pr4sh4ntSingh
Copy link

Hi All, Can I take on this one?

@TomDLT
Copy link
Member
TomDLT commented Oct 13, 2022

Yes

@pr4sh4ntSingh pr4sh4ntSingh mentioned this issue Oct 15, 2022
Closed
@jeremiedbb jeremiedbb mentioned this issue Mar 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation help wanted module:decomposition
Projects
None yet
Milestone
No milestone
4 participants
@cmarmo @TomDLT @chkoar @pr4sh4ntSingh
0