Skip to content

Commit 56ed4df

Browse files
TimothySeahpeterxcli
authored andcommitted
[train][doc] Rename checkpoint_upload_func -> checkpoint_upload_fn in docs (ray-project#60390)
Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
1 parent fbf2536 commit 56ed4df

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/source/train/doc_code/checkpoints.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ def train_fn(config):
503503
# __checkpoint_upload_mode_no_upload_end__
504504

505505

506-
# __checkpoint_upload_function_start__
506+
# __checkpoint_upload_fn_start__
507507

508508
from torch.distributed.checkpoint.state_dict_saver import async_save
509509
from s3torchconnector.dcp import S3StorageWriter
@@ -542,11 +542,11 @@ def wait_async_save(checkpoint, checkpoint_dir_name):
542542
metrics=metrics,
543543
checkpoint=checkpoint,
544544
checkpoint_upload_mode=train.CheckpointUploadMode.ASYNC,
545-
checkpoint_upload_function=wait_async_save,
545+
checkpoint_upload_fn=wait_async_save,
546546
)
547547

548548

549-
# __checkpoint_upload_function_end__
549+
# __checkpoint_upload_fn_end__
550550

551551
# __get_all_reported_checkpoints_example_start__
552552

doc/source/train/user-guides/checkpoints.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,8 +312,8 @@ you have the following options:
312312

313313
.. literalinclude:: ../doc_code/checkpoints.py
314314
:language: python
315-
:start-after: __checkpoint_upload_function_start__
316-
:end-before: __checkpoint_upload_function_end__
315+
:start-after: __checkpoint_upload_fn_start__
316+
:end-before: __checkpoint_upload_fn_end__
317317

318318
.. warning::
319319

0 commit comments

Comments
 (0)