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

Add minor doc-string change to include hp_name param in hyperparameter_search #18700

Merged
merged 3 commits into from
Aug 24, 2022
Merged

Add minor doc-string change to include hp_name param in hyperparameter_search #18700

merged 3 commits into from
Aug 24, 2022

Conversation

constantin-huetterer
Copy link
Contributor

@constantin-huetterer constantin-huetterer commented Aug 19, 2022

This is a very minor change. It seems like one of the parameters of the hyperparameter_search method hasn't been documented yet. 🙂

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@constantin-huetterer
Copy link
Contributor Author

constantin-huetterer commented Aug 20, 2022

Just noticed, that the kwargs- argument is also not displayed correctly. Probably because of the missing type-information:
image

@constantin-huetterer
Copy link
Contributor Author

Better, but still parsing issues. Maybe because of the missing white-space.
image

@constantin-huetterer
Copy link
Contributor Author

Yes, that did the trick. Now it looks alright.

image

@constantin-huetterer constantin-huetterer changed the title Add minor doc-string change to include hp_name Add minor doc-string change to include hp_name param in hyperparameter_search Aug 20, 2022
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

This looks good to me! Thank you, @constantin-huetterer!

@LysandreJik LysandreJik merged commit a442884 into huggingface:main Aug 24, 2022
oneraghavan pushed a commit to oneraghavan/transformers that referenced this pull request Sep 26, 2022
…r_search (huggingface#18700)

* Add minor doc-string change to include hp_name

* fix: missing type-information for kwargs

* fix: missing white-space in hyperparameter_search doc-strings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants