[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint to API docs#56174
Merged
justinvyu merged 6 commits intoray-project:masterfrom Sep 3, 2025
Merged
Conversation
…to API docs Signed-off-by: Timothy Seah <tseah@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds get_all_reported_checkpoints and ReportedCheckpoint to the Ray Train API documentation. The new entries are added to the correct sections and maintain the alphabetical order of the existing API lists. The changes look good.
Signed-off-by: Timothy Seah <tseah@anyscale.com>
ray-gardener
bot
added
docs
matthewdeng
approved these changes
Sep 3, 2025
| :nosignatures: | ||
| :toctree: doc/ | ||
|
|
||
| ~train.get_all_reported_checkpoints |
Contributor
There was a problem hiding this comment.
nit: I think you might need to update the return type to fix the formatting.
Contributor
Author
There was a problem hiding this comment.
Changed so the entire returns docstring is on one line.
This is what I see before my new commit - the List[ReportedCheckpoint] at the top works for me.
Signed-off-by: Timothy Seah <tseah@anyscale.com>
Signed-off-by: Timothy Seah <tseah@anyscale.com>
Signed-off-by: Timothy Seah <tseah@anyscale.com>
sampan-s-nayak
pushed a commit
to sampan-s-nayak/ray
that referenced
this pull request
Sep 8, 2025
…to API docs (ray-project#56174) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: sampan <sampan@anyscale.com>
jugalshah291
pushed a commit
to jugalshah291/ray_fork
that referenced
this pull request
Sep 11, 2025
…to API docs (ray-project#56174) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: jugalshah291 <shah.jugal291@gmail.com>
wyhong3103
pushed a commit
to wyhong3103/ray
that referenced
this pull request
Sep 12, 2025
…to API docs (ray-project#56174) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: yenhong.wong <yenhong.wong@grabtaxi.com>
dstrodtman
pushed a commit
that referenced
this pull request
Oct 6, 2025
…to API docs (#56174) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
landscapepainter
pushed a commit
to landscapepainter/ray
that referenced
this pull request
Nov 17, 2025
…to API docs (ray-project#56174) Signed-off-by: Timothy Seah <tseah@anyscale.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.