(torchx/docs) add deprecation docstring to torch_dist_role and create_torch_dist_role, added docs for configfile under experimental, fixed a few docstring errors, rearranged component toctree to be grouped more logically #266
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
…_torch_dist_role, added docs for configfile under experimental, fixed a few docstring errors, rearranged component toctree to be grouped more logically Summary: 1. add deprecation docstring to torch_dist_role and create_torch_dist_role - we cannot add a `warnings.warn(DeprecationWarning)` because unfortunately `dist.ddp` uses `torch_dist_role` (hence adding it via `warnings` will print that warning each time `dist.ddp` is loaded). 2. added docs for configfile under experimental 3. fixed a few docstring errors 4. rearranged component toctree to be grouped more logically Differential Revision: D31697032 fbshipit-source-id: 9e7d8f0a34525ef80d63eb6c2289c82929832e37
facebook-github-bot
added
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D31697032 |
Codecov Report
@@ Coverage Diff @@
## main #266 +/- ##
=======================================
Coverage 91.61% 91.61%
=======================================
Files 60 60
Lines 2767 2768 +1
=======================================
+ Hits 2535 2536 +1
Misses 232 232
Continue to review full report at Codecov.
|
|
This pull request has been merged in bd1c36d. |
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:
warnings.warn(DeprecationWarning)because unfortunatelydist.ddpusestorch_dist_role(hence adding it viawarningswill print that warning each timedist.ddpis loaded).Differential Revision: D31697032