Skip to content

[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint to API docs #56174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Sep 3, 2025
Merged

[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint to API docs #56174

merged 6 commits into from
Sep 3, 2025

Conversation

TimothySeah
Copy link
Contributor

No description provided.

@TimothySeah
[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint …
175abd5 
…to API docs

Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah TimothySeah requested review from a team as code owners September 2, 2025 21:48
gemini-code-assist[bot]
gemini-code-assist bot reviewed Sep 2, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@TimothySeah
try using class_without_autosummary instead
cff45b4 
Signed-off-by: Timothy Seah <tseah@anyscale.com>
@ray-gardener ray-gardener bot added docs An issue or change related to documentation train Ray Train Related Issue labels Sep 3, 2025
@TimothySeah TimothySeah added the go add ONLY when ready to merge, run all tests label Sep 3, 2025
matthewdeng
matthewdeng approved these changes Sep 3, 2025
View reviewed changes
doc/source/train/api/api.rst
@@ -143,6 +143,7 @@ Ray Train Utilities
:nosignatures:
:toctree: doc/

~train.get_all_reported_checkpoints
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think you might need to update the return type to fix the formatting.

Image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Screenshot 2025-09-02 at 8 15 01 PM

@TimothySeah
fix return formatting
946095c 
Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah
do multline return string
81f9f8c 
Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah
empty commit to trigger docbuild
6820c09 
Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah
Merge remote-tracking branch 'upstream/master' into tseah/document-ge…
6d852e0 
…t-all-reported
@justinvyu justinvyu merged commit 1d76e55 into ray-project:master Sep 3, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewdeng matthewdeng matthewdeng approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
docs An issue or change related to documentation go add ONLY when ready to merge, run all tests train Ray Train Related Issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@TimothySeah @matthewdeng @justinvyu