[Docs] Updating init_process_group docs to indicate correct rank range #49131
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osalpekar
requested review from
mingzhe09088,
mrshenli,
pritamdamania87,
rohan-varma and
zhaojuanmao
as code owners
facebook-github-bot
added
cla signed
oncall: distributed
|
This pull request was exported from Phabricator. Differential Revision: D25410532 |
Codecov Report
@@ Coverage Diff @@
## master #49131 +/- ##
=======================================
Coverage 80.62% 80.62%
=======================================
Files 1875 1875
Lines 202772 202772
=======================================
+ Hits 163477 163485 +8
+ Misses 39295 39287 -8 |
pytorch#49131) Summary: Pull Request resolved: pytorch#49131 Users frequently assume the correct range of ranks is 1 ... `world_size`. This PR udpates the docs to indicate that the correct rank range users should specify is 0 ... `world_size` - 1. Test Plan: Rendering and Building Docs Differential Revision: D25410532 fbshipit-source-id: dbef6394c327c93395528f5aff3e645ae392883f
|
This pull request was exported from Phabricator. Differential Revision: D25410532 |
osalpekar
force-pushed
the
export-D25410532
branch
from
f50c540
to
d4cd4a0
Compare
|
This pull request has been merged in 4b3f05a. |
| @@ -382,7 +382,8 @@ def init_process_group(backend, | |||
| Mutually exclusive with ``store``. | |||
| world_size (int, optional): Number of processes participating in | |||
| the job. Required if ``store`` is specified. | |||
| rank (int, optional): Rank of the current process. | |||
| rank (int, optional): Rank of the current process (it should be a | |||
There was a problem hiding this comment.
@osalpekar Should we do this for new_group too?
hwangdeyu
pushed a commit
to hwangdeyu/pytorch
that referenced
this pull request
Jan 6, 2021
pytorch#49131) Summary: Pull Request resolved: pytorch#49131 Users frequently assume the correct range of ranks is 1 ... `world_size`. This PR udpates the docs to indicate that the correct rank range users should specify is 0 ... `world_size` - 1. Test Plan: Rendering and Building Docs Reviewed By: mrshenli Differential Revision: D25410532 fbshipit-source-id: fe0f17a4369b533dc98543204a38b8558e68497a
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Users frequently assume the correct range of ranks is (1 ...
world_size).This PR updates the docs to indicate that the correct rank range
users should specify is (0 ...
world_size- 1).Test Plan: Rendering and Building Docs
Differential Revision: D25410532