[doc] reorg dist init and non-init functions #52976
Closed
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
facebook-github-bot
added
cla signed
oncall: distributed
💊 CI failures summary and remediationsAs of commit 8ad15a0 (more details on the Dr. CI page):
🕵️ 2 new failures recognized by patternsThe following CI failures do not appear to be due to upstream breakages:
|
| Job | Step | Action |
|---|---|---|
 quick-checks |
Ensure no trailing spaces | 🔁 rerun |
ci.pytorch.org: 1 failed
This comment was automatically generated by Dr. CI (expand for details).
Follow this link to opt-out of these comments for your Pull Requests.Please report bugs/suggestions to the (internal) Dr. CI Users group.
zou3519
added
the
triaged
There was a problem hiding this comment.
@mrshenli has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
mrshenli
requested changes
Mar 11, 2021
There was a problem hiding this comment.
Hey @stas00 , I just noticed that there is an doc build error. Could you please add 5 more "-" below "Post-Initialization"? Thanks!
Feb 27 23:42:11 =========================
Feb 27 23:42:11 /var/lib/jenkins/workspace/docs/source/distributed.rst:266: WARNING: Title underline too short.
Feb 27 23:42:11 /var/lib/jenkins/workspace/docs/source/distributed.rst:266: WARNING: Title underline too short.
|
oops, added! thank you for letting me know it was broken, @mrshenli |
mrshenli
approved these changes
Mar 12, 2021
There was a problem hiding this comment.
@mrshenli has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
xsacha
pushed a commit
to xsacha/pytorch
that referenced
this pull request
Mar 31, 2021
Summary: This PR proposes to improve the distributed doc: * [x] putting the init functions together * [x] moving post-init functions into their own sub-section as they are only available after init and moving that group to after all init sub-sections If this is too much, could we at least put these 2 functions together: ``` .. autofunction:: init_process_group .. autofunction:: is_initialized ``` as they are interconnected. and the other functions are not alphabetically sorted in the first place. Thank you. Pull Request resolved: pytorch#52976 Reviewed By: albanD Differential Revision: D26993933 Pulled By: mrshenli fbshipit-source-id: 7cacbe28172ebb5849135567b1d734870b49de77
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.
This PR proposes to improve the distributed doc:
If this is too much, could we at least put these 2 functions together:
as they are interconnected. and the other functions are not alphabetically sorted in the first place.
Thank you.