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

move block_ddp_sync_behaviour to utilities #9192

Merged
merged 8 commits into from
Aug 30, 2021
Merged

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Aug 30, 2021

What does this PR do?

Moves the context manager block_ddp_sync_behaviour in training loop to utilities. In addition:

  • renamed to block_parallel_sync_behavior because it is not ddp specific, applies generally to all parallel plugins
  • renamed "behaviour" to "behavior" since majority of our code base and docs uses american english
  • renamed the argument "should_block_sync" to just "block" for brevity.
  • updated docstring
  • made it protected to avoid reviewer commenting that it's public

Part of #9191
Related (but not blocking each other): #9101

Does your PR introduce any breaking changes? If yes, please list them.

While this method was part of the public API, nobody can really effectively use it externally, so we don't consider this a breaking change at all.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

I made sure I had fun coding 🙃

@awaelchli awaelchli added this to the v1.5 milestone Aug 30, 2021
@awaelchli awaelchli marked this pull request as ready for review August 30, 2021 00:42
@awaelchli awaelchli changed the title Refactor/block sync move block_ddp_sync_behaviour to utilities Aug 30, 2021
@codecov
Copy link

codecov bot commented Aug 30, 2021

Codecov Report

Merging #9192 (b5a7601) into master (f79993a) will increase coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #9192   +/-   ##
======================================
  Coverage      92%     92%           
======================================
  Files         176     176           
  Lines       14860   14861    +1     
======================================
+ Hits        13709   13710    +1     
  Misses       1151    1151           

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

Neat !

@tchaton tchaton enabled auto-merge (squash) August 30, 2021 09:27
@awaelchli awaelchli mentioned this pull request Aug 30, 2021
11 tasks
@mergify mergify bot added the ready PRs ready to be merged label Aug 30, 2021
@tchaton tchaton merged commit 908b9ee into master Aug 30, 2021
@tchaton tchaton deleted the refactor/block-sync branch August 30, 2021 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants