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

Fix doc string nits #23929

Merged
merged 1 commit into from
Jun 1, 2023
Merged

Fix doc string nits #23929

merged 1 commit into from
Jun 1, 2023

Conversation

sheonhan
Copy link
Contributor

@sheonhan sheonhan commented Jun 1, 2023

What does this PR do?

Fixes a couple docstring nits discovered while working on another PR

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -136,7 +136,7 @@ class PretrainedConfig(PushToHubMixin):
diversity_penalty (`float`, *optional*, defaults to 0.0):
Value to control diversity for group beam search. that will be used by default in the `generate` method of
the model. 0 means no diversity penalty. The higher the penalty, the more diverse are the outputs.
temperature (`float`, *optional*, defaults to 1):
temperature (`float`, *optional*, defaults to 1.0):
Copy link
Collaborator

Choose a reason for hiding this comment

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

The type is clearly indicated, not sure what this change brings honestly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I just saw that other ones with float as its type (like diversity_penalty (float, *optional*, defaults to 0.0) right above) had its value formatted like 0.0, so I thought I'd just change it for consistency

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jun 1, 2023

The documentation is not available anymore as the PR was closed or merged.

@sgugger sgugger merged commit af2c367 into huggingface:main Jun 1, 2023
@sheonhan sheonhan deleted the docstring-nits branch June 1, 2023 16:28
gojiteji pushed a commit to gojiteji/transformers that referenced this pull request Jun 5, 2023
novice03 pushed a commit to novice03/transformers that referenced this pull request Jun 23, 2023
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