[Train] Update checkpoint path for RayTrainReportCallbacks. #40174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
woshiyyya
requested review from
richardliaw,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
maxpumperla,
justinvyu and
a team
as code owners
woshiyyya
changed the title
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Yunxuan Xiao <yunxuanx@anyscale.com>
woshiyyya
added
the
tests-ok
matthewdeng
reviewed
Oct 11, 2023
python/ray/train/huggingface/transformers/_transformers_utils.py
Outdated
Show resolved
Hide resolved
python/ray/train/huggingface/transformers/_transformers_utils.py
Outdated
Show resolved
Hide resolved
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com> Signed-off-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
…' into update_report_callback_ckpt_path
matthewdeng
reviewed
Oct 13, 2023
python/ray/train/huggingface/transformers/_transformers_utils.py
Outdated
Show resolved
Hide resolved
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
matthewdeng
reviewed
Oct 16, 2023
Comment on lines
226
to
231
| Checkpoints will be saved in the following structure: | ||
|
|
||
| .. testcode:: | ||
|
|
||
| # checkpoint_00000*/ Ray Train Checkpoint | ||
| # └─ checkpoint.ckpt PyTorch Lightning Checkpoint |
There was a problem hiding this comment.
Can you try this:
Suggested change
| Checkpoints will be saved in the following structure: | |
| .. testcode:: | |
| # checkpoint_00000*/ Ray Train Checkpoint | |
| # └─ checkpoint.ckpt PyTorch Lightning Checkpoint | |
| Checkpoints will be saved in the following structure:: | |
| checkpoint_00000*/ Ray Train Checkpoint | |
| └─ checkpoint.ckpt PyTorch Lightning Checkpoint |
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
matthewdeng
approved these changes
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
In our doc, we didn't explicitly explain how to retrieve the original checkpoint files if using Ray Train provided report callbacks. This PR add some code snippets for users.
Related issue number
Closes #40082
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.