Stop showing .api as an API path component in RPC docs #30160
Closed
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
[ghstack-poisoned]
mrshenli
requested review from
pritamdamania87,
rohan-varma and
zhaojuanmao
and removed request for
rohan-varma
Contributor
Author
|
|
The path torch.distributed.rpc.api is an implementation detail, which should not be used by applications to import RPC APIs. Instead, all RPC APIs are exposed directly as torch.distributed.rpc.*. This commit makes the API doc consistent with the above expectation. Differential Revision: [D18616359](https://our.internmc.facebook.com/intern/diff/D18616359) [ghstack-poisoned]
rohan-varma
approved these changes
Nov 20, 2019
Contributor
rohan-varma
left a comment
rohan-varma
left a comment
There was a problem hiding this comment.
Thanks for doing this!
rohan-varma
reviewed
Nov 20, 2019
|
|
||
| .. automodule:: torch.distributed.rpc.api | ||
| :members: | ||
| .. automodule:: torch.distributed.rpc |
Contributor
There was a problem hiding this comment.
I was trying to do something similar when working on the first version of this docs, but the downside with this approach is that if we add a new function, we'd have to manually remember to add to the doc here. Not sure how to get around that.
Contributor
Author
There was a problem hiding this comment.
I agree, that is indeed a problem for this approach, and we can figure out how to solve it later (Maybe remove api.py and move everything to __init__.py). As for now, let's make sure the doc exposes the correct path.
Contributor
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.
Stack from ghstack:
The path torch.distributed.rpc.api is an implementation detail, which
should not be used by applications to import RPC APIs. Instead, all
RPC APIs are exposed directly as torch.distributed.rpc.*. This
commit makes the API doc consistent with the above expectation.
closes #30014
Differential Revision: D18616359