Polish API documentation #123
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
facebook-github-bot
added
the
CLA Signed
Contributor
|
@yifuwang has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
yifuwang
force-pushed
the
polish_api_doc
branch
from
7dd4b1d to
b49ef4b
Compare
Codecov Report
@@ Coverage Diff @@
## main #123 +/- ##
==========================================
- Coverage 92.90% 92.23% -0.68%
==========================================
Files 30 30
Lines 2523 2523
==========================================
- Hits 2344 2327 -17
- Misses 179 196 +17
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
edward-io
reviewed
Oct 28, 2022
torchsnapshot/snapshot.py
Outdated
| storage_options: Additional keyword options for the StoragePlugin to use. | ||
| See each StoragePlugin's documentation for customizations. | ||
| app_state (Dict[str, Stateful]): The application state to persist. | ||
| It take the form of a dictionary, with the keys being |
edward-io
reviewed
Oct 28, 2022
| of :meth:`Snapshot.take`. If none, the default process group will | ||
| be used. | ||
| replicated (List[str], optional): Glob patterns for marking |
Contributor
There was a problem hiding this comment.
do we have examples of what this looks like?
edward-io
approved these changes
Oct 28, 2022
yifuwang
force-pushed
the
polish_api_doc
branch
from
b49ef4b to
f203a8c
Compare
Contributor
|
@yifuwang has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
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.
As title.