docs(trainer): add JIT checkpointing to trainer recipes#46826
Merged
Conversation
Add documentation for the JIT checkpointing feature (enable_jit_checkpoint) in the Checkpointing section of trainer_recipes.md, as requested during PR huggingface#41723 review.
stevhliu
approved these changes
Jun 23, 2026
stevhliu
left a comment
Member
There was a problem hiding this comment.
thanks for adding docs! would you also mind updating the docstring to match the docs (--signal=USR1@<seconds> --> --signal=TERM@300)?
- Reword docs for clarity and tone consistency - Clarify sentinel file behavior and that Trainer does not auto-check it - Include kill_wait delay in grace period calculation - Fix Slurm signal flag in training_args.py docstring (USR1 -> TERM)
Contributor
|
CI Dashboard: View test results in Grafana |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
This file contains hidden or 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
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.
Adds documentation for JIT checkpointing (
enable_jit_checkpoint) to the Checkpointing section oftrainer_recipes.md, as requested by @SunMarc in #41723.Covers what JIT checkpointing is, how it differs from periodic checkpointing, usage, and orchestrator grace period configuration for Kubernetes and Slurm.