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

Update strategy flag in docs #10000

Merged
merged 14 commits into from Oct 20, 2021
Merged

Update strategy flag in docs #10000

merged 14 commits into from Oct 20, 2021

Conversation

kaushikb11
Copy link
Contributor

@kaushikb11 kaushikb11 commented Oct 18, 2021

What does this PR do?

Update strategy flag in the docs. It will replace accelerator and plugins flags for training strategies.

Related Issues: #9053, #9932

The follow-up PR would be updating the Trainer flag documentation (accelerator, strategy) and required changes for ddp_cpu

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

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 list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
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?

Make sure you had fun coding 🙃

@kaushikb11 kaushikb11 changed the title Update strategy flag in docs (1/n) Update strategy flag in docs Oct 19, 2021
@kaushikb11 kaushikb11 added the docs Documentation related label Oct 19, 2021
@kaushikb11 kaushikb11 added this to the v1.5 milestone Oct 19, 2021
@kaushikb11 kaushikb11 marked this pull request as ready for review October 19, 2021 19:24
@kaushikb11 kaushikb11 changed the title (1/n) Update strategy flag in docs Update strategy flag in docs Oct 19, 2021
@codecov
Copy link

codecov bot commented Oct 19, 2021

Codecov Report

Merging #10000 (bfed77f) into master (2ed92ec) will decrease coverage by 0%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #10000   +/-   ##
=======================================
- Coverage      93%      93%   -0%     
=======================================
  Files         180      180           
  Lines       15892    15892           
=======================================
- Hits        14722    14720    -2     
- Misses       1170     1172    +2     

Copy link
Member

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

find and replace 📎 ✏️

pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Oct 19, 2021
@mergify mergify bot removed the has conflicts label Oct 20, 2021
@kaushikb11 kaushikb11 enabled auto-merge (squash) October 20, 2021 14:22
@kaushikb11 kaushikb11 merged commit 56bc55d into master Oct 20, 2021
@kaushikb11 kaushikb11 deleted the docs/strategy branch October 20, 2021 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants