Repository navigation
Align the cancel and warmup prose with the writing standard - #396
Merged
Merged
Conversation
The warmup section claimed an unreadable `SHAPE_WARMUP_API_KEY_FILE` only warns. Both launchers exit 20 at their key-file check before `docker run -d`, so the section now states that it stops the launch. The installation reference links to the cancel section instead of repeating its mechanism, the cancel section records the `failed` state an interrupted installation writes when its restore did not complete, and duplicated mechanism sentences leave the quickstart and the script docstring. The env templates state that the warmup stays off until calibration, and `scripts/config/*.env.example` is regenerated from them. The operator view appends `rollout.SWITCH_NEXT`, so a group member and `sudo sparkring status` name the same action for an unsettled switch. That is the only behavior change; `profiles/environment-exports.json` is unchanged. Validation: `pytest runtime/host` (2078 passed, 86 skipped), `pytest scripts/test_deepseek_v4_shape_warmup.py scripts/test_deepseek_v4_pair_launcher.py` (135 passed), `ruff check --select E,F,W --ignore E501 runtime scripts`, `scripts/check_repository_layout.py` (1201 sources) and `scripts/check_markdown_links.py .` (4231 links).
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.
What and why
This corrects prose in
docs/operations/deepseek-0731.md, the cancel sections ofdocs/operations/commands.mdanddocs/operations/install-reference.md, the module comments that accompany them, and the warmup environment templates. It has one behavior change.SHAPE_WARMUP_API_KEY_FILEwarns and the container keeps serving. Both launchers exit 20 at that check beforedocker run -d, so the section now says the launch stops before the container starts. The--cancelexit contract gains thefailedstate an interrupted installation writes when its restore did not complete.runtime/host/operator_view.linesappendsrollout.SWITCH_NEXT, so a group member'sModel switch: ... | next:names the same action as rootstatusrather than a shorter paraphrase.Compatibility
| next: sudo sparkring install --cancel stops it and records it cancelled, or install that model again to resume itinstead of| next: an operator's sudo sparkring install --cancel.scripts/config/*.env.exampleis regenerated fromprofiles/*/runtime.env.template; the template edits are comments only.profiles/environment-exports.jsonbaselines are unchanged and the layout check validates them.Validation
python3 -m pytest runtime/host -q: 2078 passed, 86 skipped.python3 -m pytest scripts/test_deepseek_v4_shape_warmup.py scripts/test_deepseek_v4_pair_launcher.py -q: 135 passed.python3 -m ruff check --select E,F,W --ignore E501 runtime scripts: clean.python3 scripts/check_repository_layout.py: 50 profiles, 54 exports, 430 preserved inputs, 22 locked profile assets, 1201 Python sources.python3 scripts/check_markdown_links.py .: 4231 links.runtime/host/test_cancel.pyassertion covers the cancel command name in the operator view.