docs: add documentation for workspaces + general cleanup #402
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
facebook-github-bot
added
the
CLA Signed
|
@d4l3k has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Codecov Report
@@ Coverage Diff @@
## main #402 +/- ##
=======================================
Coverage 94.53% 94.54%
=======================================
Files 66 66
Lines 3663 3664 +1
=======================================
+ Hits 3463 3464 +1
Misses 200 200
Continue to review full report at Codecov.
|
d4l3k
added a commit
that referenced
this pull request
Mar 1, 2022
Summary: This makes some of the changes listed in https://docs.google.com/document/d/14icG0GJG1nPHF3DW7yMreZpe3S8FwYdrI_XYIzDTSbI/edit#heading=h.6ixj5co4aocb * Adds workspaces documention * Adds coverage test to docs build to ensure all exported methods/classes are documented in the docs. * Adds previously undocumented methods/classes to docs * Moves torchconfig from experimental to beta * Splits docker/local scheduler docs * Reshuffles the sidebar to prioritize the schedulers over some of the other content Next steps: * update readme/index/quickstart guides to highlight workspaces + patching w/ ddp builtin * deprioritize/remove some of the more complex custom component examples Pull Request resolved: #402 Test Plan: ``` $ make -C docs coverage; and cat docs/build/0.1.2dev0/coverage/python.txt $ pyre $ pytest ``` CI  Reviewed By: kiukchung Differential Revision: D34540003 Pulled By: d4l3k fbshipit-source-id: 585d2ad5f35d87c0451ba6fb1e3fd68b5e0e6e0e
|
This pull request was exported from Phabricator. Differential Revision: D34540003 |
Summary: This makes some of the changes listed in https://docs.google.com/document/d/14icG0GJG1nPHF3DW7yMreZpe3S8FwYdrI_XYIzDTSbI/edit#heading=h.6ixj5co4aocb * Adds workspaces documention * Adds coverage test to docs build to ensure all exported methods/classes are documented in the docs. * Adds previously undocumented methods/classes to docs * Moves torchconfig from experimental to beta * Splits docker/local scheduler docs * Reshuffles the sidebar to prioritize the schedulers over some of the other content Next steps: * update readme/index/quickstart guides to highlight workspaces + patching w/ ddp builtin * deprioritize/remove some of the more complex custom component examples Pull Request resolved: #402 Test Plan: ``` $ make -C docs coverage; and cat docs/build/0.1.2dev0/coverage/python.txt $ pyre $ pytest ``` CI  Reviewed By: kiukchung Differential Revision: D34540003 Pulled By: d4l3k fbshipit-source-id: 271b084d36bdf256547cae755fbeb0e603abac66
|
This pull request was exported from Phabricator. Differential Revision: D34540003 |
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 makes some of the changes listed in https://docs.google.com/document/d/14icG0GJG1nPHF3DW7yMreZpe3S8FwYdrI_XYIzDTSbI/edit#heading=h.6ixj5co4aocb
Next steps:
Test plan:
CI