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 inverse sqrt learning rate scheduler #21495

Merged
merged 10 commits into from
Feb 7, 2023

Conversation

Sager611
Copy link
Contributor

@Sager611 Sager611 commented Feb 7, 2023

What does this PR do?

Adds the original invserse sqrt learning rate scheduler from Vaswani et al. (2017).

It is argued that this scheduler achieves the best performance when scaling ViTs on indefinite training times (Zhai et al. (2022)).

This PR ads a get_inverse_sqrt_schedule function and also updates the test in tests/optimization/test_optimization.py and the docs.

The implementation is adapted from:

Timescale equals the no. of warmup steps by default as in:

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your 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 for adding this! I just have one comment.

Comment on lines 240 to 241
Note: this implementation is adapted from
https://github.com/google-research/big_vision/blob/f071ce68852d56099437004fd70057597a95f6ef/big_vision/utils.py#L930
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be a comment in the doc, the user reading the documentation won't really care about this.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Feb 7, 2023

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

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