Skip to content

Add autodoc for BestOfNSampler and improve docstrings #4034

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
Merged
merged 15 commits into from
Sep 9, 2025
Merged

Add autodoc for BestOfNSampler and improve docstrings #4034

merged 15 commits into from
Sep 9, 2025

Conversation

albertvillanova
Copy link
Member

@albertvillanova albertvillanova commented Sep 8, 2025 •
edited
Loading

Add autodoc for BestOfNSampler classes and improve docstrings.

@HuggingFaceDocBuilderDev
Copy link

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

qgallouedec
qgallouedec approved these changes Sep 8, 2025
View reviewed changes
Copy link
Member

@qgallouedec qgallouedec left a comment

Choose a reason for hiding this comment

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

A few remarks, otherwise Lgtm!

@albertvillanova
Copy link
Member Author

albertvillanova commented Sep 8, 2025 •
edited
Loading

Thanks for the review, @qgallouedec.

Note that I just added the autodoc and moved the existing docstring from __init__ to the class declaration part, so it appears in the online docs. I did not worked further in correction of types, inter-links, description, etc, because I prioritized the addition of the docstring. But I can work on it as you suggested and change the title of the PR: 😅

Add autodoc for BestOfNSampler and improve docstring

@qgallouedec
Copy link
Member

Yes you're right, let's stay organized ;)

@qgallouedec qgallouedec mentioned this pull request Sep 8, 2025
Closed
@albertvillanova albertvillanova changed the title Add autodoc for BestOfNSampler Add autodoc for BestOfNSampler and improve docstrings Sep 8, 2025
@albertvillanova
Copy link
Member Author

I guess I can merge this PR as it is.

@qgallouedec
Copy link
Member

Sure

@albertvillanova albertvillanova merged commit a228cb5 into huggingface:main Sep 9, 2025
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qgallouedec qgallouedec qgallouedec approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@albertvillanova @HuggingFaceDocBuilderDev @qgallouedec