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

Merged
merged 6 commits into from
Sep 3, 2025
Merged

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

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
175abd5
[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint …
TimothySeah Sep 2, 2025
cff45b4
try using class_without_autosummary instead
TimothySeah Sep 2, 2025
946095c
fix return formatting
TimothySeah Sep 3, 2025
81f9f8c
do multline return string
TimothySeah Sep 3, 2025
6820c09
empty commit to trigger docbuild
TimothySeah Sep 3, 2025
6d852e0
Merge remote-tracking branch 'upstream/master' into tseah/document-ge…
TimothySeah Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/train/api/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ Ray Train Utilities
:toctree: doc/

~train.Checkpoint
~train.ReportedCheckpoint
~train.v2.api.context.TrainContext

**Functions**
Expand All @@ -143,6 +144,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

~train.get_checkpoint
~train.get_context
~train.get_dataset_shard
Expand Down