Skip to content
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

DOC Ensures that BernoulliRBM passes numpydoc validation #20533

Merged
merged 16 commits into from
Sep 1, 2021

Conversation

reshamas
Copy link
Member

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

Fixes numpydoc errors on BernouilliRBM functions

Any other comments?

#DataUmbrella LATAM sprint

Question

For verbose, it is currently what is below. What are the possible options for verbose, the range of integer values that it can take?:

 verbose : int, default=0
        The verbosity level. The default, zero, means silent mode.

sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
sklearn/neural_network/_rbm.py Outdated Show resolved Hide resolved
>>> model = BernoulliRBM(n_components=2)
>>> model.fit(X)
BernoulliRBM(n_components=2)
gibbs: Gibbs sampling step.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we should document some public functions or public classes. gibbs is a method of the estimator so it would not fit here. However, I am not sure which public class to document here. @ogrisel Do you think that it makes sense to add any manifold learning method or a PCA?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So MLPClassifier/MLPRegressor and PCA are good candidates.

reshamas and others added 6 commits July 15, 2021 09:26
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@reshamas
Copy link
Member Author

@glemaitre Can we specify the range of values that verbose can take? (line 53). Is it [0, inf]?

@glemaitre
Copy link
Member

Yes we can add information about the range. However, it should be in the description and not in the line of the data type.

@reshamas
Copy link
Member Author

@glemaitre I looked at the tests and I am not understanding why they are failing.

@glemaitre
Copy link
Member

It seems unrelated because it is the IterativeImputer that complains about a warning. We need to investigate what is the reason.

@glemaitre glemaitre self-requested a review September 1, 2021 09:55
@glemaitre
Copy link
Member

I merge with main and improve the See Also section. We should be good if the CIs pass.

@glemaitre glemaitre merged commit 5687c1d into scikit-learn:main Sep 1, 2021
@reshamas reshamas deleted the BernouilliRBM branch September 1, 2021 12:45
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…n#20533)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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.

2 participants