[train][doc] Rename checkpoint_upload_func -> checkpoint_upload_fn in docs#60390
Conversation
… docs Signed-off-by: Timothy Seah <tseah@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to rename checkpoint_upload_function to checkpoint_upload_fn. The changes are consistent across the modified documentation code example and the reStructuredText file that includes it. This is a good change for consistency with the actual API. The changes look correct and I have no further comments.
| metrics=metrics, | ||
| checkpoint=checkpoint, | ||
| checkpoint_upload_mode=train.CheckpointUploadMode.ASYNC, | ||
| checkpoint_upload_function=wait_async_save, |
There was a problem hiding this comment.
Can we enable tests for this so this kind of thing gets caught in the future?
There was a problem hiding this comment.
I can add a release test variant that tests this.
As for doc tests - many of the current doc tests in checkpoints.py don't actually call trainer.fit, and this one in particular is hard to run because it requires saving to S3. Lmk if you have any best practices for this.
There was a problem hiding this comment.
Ah got it. I think since this is more like pseudocode we shouldn't run it. Though having separate python flies like this are meant to make it so that you can run them. For future reference you can use something like code-block instead.
ray-gardener
bot
added
docs
… docs (ray-project#60390) Signed-off-by: Timothy Seah <tseah@anyscale.com>
… docs (ray-project#60390) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: jinbum-kim <jinbum9958@gmail.com>
… docs (ray-project#60390) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: 400Ping <jiekaichang@apache.org>
… docs (ray-project#60390) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
… docs (ray-project#60390) Signed-off-by: Timothy Seah <tseah@anyscale.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
2 participants
Summary
Simple text change
Testing
docbuild