[rpc] polish examples in docstrings and update docs to reflect correct use of rpc.init_rpc #30052
Conversation
This file contains hidden or 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
…t use of rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
rohan-varma
requested review from
mrshenli,
pritamdamania87 and
zhaojuanmao
as code owners
rohan-varma
added a commit
that referenced
this pull request
Nov 18, 2019
…t use of rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) ghstack-source-id: 94155096 Pull Request resolved: #30052
rohan-varma
commented
Nov 18, 2019
docs/source/rpc.rst
Outdated
| and distributed autograd. As part of this, it will also initialize a default | ||
| `ProcessGroup` `backend | ||
| <https://pytorch.org/docs/stable/distributed.html#torch.distributed.Backend>`_ | ||
| that uses gloo for collective communication. |
There was a problem hiding this comment.
Basically, I'm trying to express that init_rpc runs dist.init_process_group(backend=GLOO) behind the scenes, is there a better way to write this?
There was a problem hiding this comment.
Rewrite this as follows to make it clear that the default is ProcessGroup but other backends be available:
By default, this will initialize the `ProcessGroup` backend. The `ProcessGroup` backend internally uses gloo for communication
pritamdamania87
approved these changes
Nov 18, 2019
docs/source/rpc.rst
Outdated
| and distributed autograd. As part of this, it will also initialize a default | ||
| `ProcessGroup` `backend | ||
| <https://pytorch.org/docs/stable/distributed.html#torch.distributed.Backend>`_ | ||
| that uses gloo for collective communication. |
There was a problem hiding this comment.
Rewrite this as follows to make it clear that the default is ProcessGroup but other backends be available:
By default, this will initialize the `ProcessGroup` backend. The `ProcessGroup` backend internally uses gloo for communication
docs/source/rpc.rst
Outdated
| and distributed autograd. | ||
| and distributed autograd. As part of this, it will also initialize a default | ||
| `ProcessGroup` `backend | ||
| <https://pytorch.org/docs/stable/distributed.html#torch.distributed.Backend>`_ |
There was a problem hiding this comment.
Use :ref: for this link instead of the full path.
…lect correct use of rpc.init_rpc" rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
rohan-varma
added a commit
that referenced
this pull request
Nov 19, 2019
…t use of rpc.init_rpc Pull Request resolved: #30052 Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. ghstack-source-id: 94200238 Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/)
…lect correct use of rpc.init_rpc" rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
rohan-varma
added a commit
that referenced
this pull request
Nov 20, 2019
…t use of rpc.init_rpc Pull Request resolved: #30052 Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. ghstack-source-id: 94247167 Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/)
…lect correct use of rpc.init_rpc" rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
…lect correct use of rpc.init_rpc" rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
rohan-varma
added a commit
that referenced
this pull request
Nov 20, 2019
…t use of rpc.init_rpc Pull Request resolved: #30052 Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. ghstack-source-id: 94256844 Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/)
…lect correct use of rpc.init_rpc" rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc** * #30050 [rpc] rename join_rpc to wait_all_workers in public api rpc.init_rpc Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/) [ghstack-poisoned]
rohan-varma
added a commit
that referenced
this pull request
Nov 20, 2019
…t use of rpc.init_rpc Pull Request resolved: #30052 Some of the examples provided in `rpc/api.py` were not updated along with the code changes, this PR updates them. Also removes the `dist.ProcessGroup` information since `init_rpc` now initializes a default process group. ghstack-source-id: 94273004 Differential Revision: [D18582596](https://our.internmc.facebook.com/intern/diff/D18582596/)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Stack from ghstack:
Some of the examples provided in
rpc/api.pywere not updated alongwith the code changes, this PR updates them. Also removes the
dist.ProcessGroupinformation sinceinit_rpcnow initializes a defaultprocess group.
Differential Revision: D18582596