[Train][transformers] Skip reporting checkpoint when get_latest_checkpoint
returns None.
#42953
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?
An OSS users found that RayTrainReportCallback fails to copy checkpoint while doing multi-node distributed training: #42926
Previously, transformers Trainer first creates a tmp dir for all workers to save checkpoint files, then renames the
tmp-checkpoint-*
dir tocheckpoint-*
on all workers. They recently introduced a behavior change, which forces it to only rename on global-rank-0 worker (if save_on_all_nodes=False). Therefore, except for node of rank 0 worker, the remaining nodes still keep thetmp-checkpoint-*
dir around, and returns None intransformers.trainer.get_last_checkpoint
since nocheckpoint-*
folders are found in the theargs.output_dir
(see here).This PR modifies
ray.train.transformers.RayTrainReportCallback
to only report checkpoint whentransformers.trainer.get_latest_checkpoint
returns a valid path. This is to address a behavior change made in transformers starting in4.37.0
where only the global rank 0 worker will rename the temporary checkpoint directory so that it is found by thisget_latest_checkpoint
function.Update: This feature is introduced in the lastest transformers version, but we will not update the package version to avoid breaking other tests.
Related issue number
Closes: #42926
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.