Skip to content

[train][doc] Document get_all_reported_checkpoints#58946

Merged
justinvyu merged 4 commits intoray-project:masterfrom
TimothySeah:tseah/doc-get-all-reported
Nov 30, 2025
Merged

[train][doc] Document get_all_reported_checkpoints#58946
justinvyu merged 4 commits intoray-project:masterfrom
TimothySeah:tseah/doc-get-all-reported

Conversation

@TimothySeah
Copy link
Contributor

@TimothySeah TimothySeah commented Nov 24, 2025

Summary

Document the new ray.train.get_all_reported_checkpoints method.

Testing

docbuild looked good

Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah TimothySeah requested review from a team as code owners November 24, 2025 20:28
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 documentation for the new ray.train.get_all_reported_checkpoints method. The changes include adding a new section to the checkpoints user guide and a corresponding code example. The documentation is clear and well-written. I found one issue in the code example where an argument was passed positionally instead of as a keyword argument, which would cause a runtime error. I've suggested a fix for this.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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 Nov 25, 2025
Signed-off-by: Timothy Seah <tseah@anyscale.com>
Copy link
Contributor

@justinvyu justinvyu left a comment

Choose a reason for hiding this comment

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

Thanks!

Co-authored-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Timothy Seah <tseah@anyscale.com>
@TimothySeah TimothySeah added the go add ONLY when ready to merge, run all tests label Nov 26, 2025
@justinvyu justinvyu merged commit 60f45f6 into ray-project:master Nov 30, 2025
7 checks passed
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
Document the new `ray.train.get_all_reported_checkpoints` method.

---------

Signed-off-by: Timothy Seah <tseah@anyscale.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: peterxcli <peterxcli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

2 participants