[Docs] [Train] Update Train API reference and docs #28192
Merged
Conversation
This file contains 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
Signed-off-by: Amog Kamsetty <[email protected]>
Signed-off-by: Amog Kamsetty <[email protected]>
richardliaw
reviewed
Aug 31, 2022
doc/source/train/api.rst
Outdated
| @@ -7,6 +7,73 @@ This page covers advanced configurations for specific frameworks using Train. | |||
|
|
|||
| For different high level trainers and their usage, take a look at the :ref:`AIR Trainer package reference <air-trainer-ref>`. | |||
|
|
|||
| .. _train-api-torch-utils: | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
Idts- these are not part of the AIR session API
There was a problem hiding this comment.
then why do we need :no-index:?
There was a problem hiding this comment.
Updated the PR, PTAL!
Signed-off-by: Amog Kamsetty <[email protected]>
Signed-off-by: Amog Kamsetty <[email protected]>
richardliaw
approved these changes
Sep 1, 2022
|
Failing tests are fixed on master |
XiaodongLv
pushed a commit
to XiaodongLv/ray
that referenced
this pull request
Sep 2, 2022
Signed-off-by: Amog Kamsetty [email protected] Adds back more Ray Train APIs to Ray Train docs. Also makes updates to the user guide for better references.
ilee300a
pushed a commit
to ilee300a/ray
that referenced
this pull request
Sep 12, 2022
Signed-off-by: Amog Kamsetty [email protected] Adds back more Ray Train APIs to Ray Train docs. Also makes updates to the user guide for better references. Signed-off-by: ilee300a <[email protected]>
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.
Signed-off-by: Amog Kamsetty [email protected]
Adds back more Ray Train APIs to Ray Train docs.
Also makes updates to the user guide for better references.
Why are these changes needed?
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.