Skip to content

Conversation

@mreraser
Copy link
Contributor

@mreraser mreraser commented Oct 8, 2024

What does this PR do?

Fixes #9567

  • put function explanation before "Args"
  • correct indentation

Before submitting

Who can review?

Hello @a-r-r-o-w, @yiyixuxu, and @stevhliu! May I kindly ask for your review? (or anyone who wants to review)

I would greatly appreciate it if anyone who is available could take some time to look it over.

Thank you in advance for your time and assistance!

@yiyixuxu yiyixuxu requested a review from stevhliu October 8, 2024 16:32
@HuggingFaceDocBuilderDev

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.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Nice! You can run make style to apply automatic style corrections to fix the failing CI test :)

@mreraser
Copy link
Contributor Author

mreraser commented Oct 10, 2024

Nice! You can run make style to apply automatic style corrections to fix the failing CI test :)

Thank you for the guidance @stevhliu ! 🙌 I ran make style. Really appreciate your help!

@a-r-r-o-w
Copy link
Contributor

@sayakpaul Do you know why we're having the documentation test fails? It is unrelated to the changes in PR and seems like an environment problem

@sayakpaul
Copy link
Member

@a-r-r-o-w
Copy link
Contributor

oh okay. can we merge PRs in the meantime or do we wait until fixed? i think there were a few merges earlier so should be good i guess?

@sayakpaul
Copy link
Member

Yes we can merge before!

Copy link
Contributor

@a-r-r-o-w a-r-r-o-w left a comment

Choose a reason for hiding this comment

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

thanks!

@a-r-r-o-w a-r-r-o-w merged commit 355bb64 into huggingface:main Oct 15, 2024
15 checks passed
sayakpaul added a commit that referenced this pull request Dec 23, 2024
* refac: docstrings in training_utils.py

* fix: manual edits

* run make style

* add docstring at cast_training_params

---------

Co-authored-by: Sayak Paul <[email protected]>
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.

[community] Improving docstrings and type hints

5 participants