Skip to content

Commit 4948cf2

Browse files
TimothySeahdstrodtman
authored andcommitted
[train][doc] Add get_all_reported_checkpoints and ReportedCheckpoint to API docs (#56174)
Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
1 parent de4c904 commit 4948cf2

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

doc/source/train/api/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ Ray Train Utilities
143143
:nosignatures:
144144
:toctree: doc/
145145

146+
~train.get_all_reported_checkpoints
146147
~train.get_checkpoint
147148
~train.get_context
148149
~train.get_dataset_shard
@@ -165,6 +166,7 @@ Ray Train Output
165166
:template: autosummary/class_without_autosummary.rst
166167
:toctree: doc/
167168

169+
~train.ReportedCheckpoint
168170
~train.Result
169171

170172
Ray Train Errors

python/ray/train/v2/api/train_fn_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ def train_func(config):
192192
193193
Returns:
194194
List of ReportedCheckpoint objects that represent the checkpoints and
195-
corresponding metrics reported by the workers.
195+
corresponding metrics reported by the workers.
196196
"""
197197
return get_train_fn_utils().get_all_reported_checkpoints()
198198

0 commit comments

Comments
 (0)