Skip to content

Rename checkpoint trigger file to be product-agnostic#704

Merged
RobotSail merged 2 commits intomainfrom
rename-checkpoint-trigger-file
Apr 30, 2026
Merged

Rename checkpoint trigger file to be product-agnostic#704
RobotSail merged 2 commits intomainfrom
rename-checkpoint-trigger-file

Conversation

@RobotSail
Copy link
Copy Markdown
Member

@RobotSail RobotSail commented Apr 30, 2026

Summary

  • Renames the on-demand checkpoint sentinel file from instructlab_checkpoint_requested to checkpoint_requested so it is not tied to a specific product name.
  • Adds support for overriding the trigger filename via the CHECKPOINT_TRIGGER_FILENAME environment variable.
  • Updates the source, tests, and docs to match.

Test plan

  • All 23 tests in test_on_demand_checkpoint.py pass (including new env var override test)

🤖 Generated with Claude Code

The on-demand checkpoint sentinel file in /dev/shm was named
"instructlab_checkpoint_requested" — rename it to the generic
"checkpoint_requested" so the mechanism is not tied to a specific
product name.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

📝 Walkthrough

Walkthrough

The trigger filename for on-demand checkpointing is renamed from "instructlab_checkpoint_requested" to "checkpoint_requested" in the implementation constant, documentation, and corresponding unit tests. All three files are updated consistently to reflect this single naming change.

Changes

Cohort / File(s) Summary
On-demand checkpoint trigger filename update
src/instructlab/training/on_demand_checkpoint.py, docs/on_demand_checkpointing.md, tests/unit/test_on_demand_checkpoint.py
Updated the trigger file path constant and all related references from "instructlab_checkpoint_requested" to "checkpoint_requested" across implementation, documentation, and unit tests.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

testing, one-approval

Suggested reviewers

  • Maxusmusti

Poem

🐰 A shorter name hops into place,
checkpoint_requested sets the pace,
No more instructlab in the way,
Cleaner paths for every day!
✨📝

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Rename checkpoint trigger file to be product-agnostic' directly and accurately summarizes the main change: renaming the checkpoint trigger file from a product-specific name to a generic one across code, tests, and documentation.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rename-checkpoint-trigger-file

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mergify mergify Bot added the testing Relates to testing label Apr 30, 2026
@RobotSail RobotSail requested a review from Maxusmusti April 30, 2026 18:53
Read CHECKPOINT_TRIGGER_FILENAME from os.environ at call time in
_get_trigger_path() instead of using a module-level constant. This
lets users customize the trigger filename for environments where
multiple training jobs share the same /dev/shm.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mergify mergify Bot added the one-approval label Apr 30, 2026
@RobotSail RobotSail merged commit fa5b53b into main Apr 30, 2026
14 checks passed
@RobotSail RobotSail deleted the rename-checkpoint-trigger-file branch April 30, 2026 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

one-approval testing Relates to testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants