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 note about GradientState being in-sync with the dataloader by default #2134

Merged
merged 2 commits into from
Nov 14, 2023

Conversation

muellerzr
Copy link
Collaborator

What does this PR do?

Adds a note in the docs about how during DDP the model will synchronize on the last step through the dataloader at the end, and how if this is a behavior not wanted it can be avoided.

Fixes #1847

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.

@BenjaminBossan

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Nov 8, 2023

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

Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

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

Just nits, up to you if you want to address them, rest LGTM. Thanks.

docs/source/usage_guides/gradient_accumulation.md Outdated Show resolved Hide resolved
@BenjaminBossan
Copy link
Member

Thanks for clarifying the description, LGTM.

@muellerzr muellerzr merged commit 8dedb14 into main Nov 14, 2023
4 checks passed
@muellerzr muellerzr deleted the sync-doc branch November 14, 2023 16:53
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.

GradientState being in sync with the DataLoader by default could be specified in the doc.
3 participants