Skip to content

Align the cancel and warmup prose with the writing standard - #396

Merged
FujitsuPolycom merged 1 commit into
mainfrom
prose-standard
Nov 2, 2026
Merged

FujitsuPolycom merged 1 commit into
mainfrom
prose-standard

Conversation

@FujitsuPolycom

Copy link
Copy Markdown
Owner

What and why

This corrects prose in docs/operations/deepseek-0731.md, the cancel sections of docs/operations/commands.md and docs/operations/install-reference.md, the module comments that accompany them, and the warmup environment templates. It has one behavior change.

  • Corrected claim. The warmup section said an unreadable SHAPE_WARMUP_API_KEY_FILE warns and the container keeps serving. Both launchers exit 20 at that check before docker run -d, so the section now says the launch stops before the container starts. The --cancel exit contract gains the failed state an interrupted installation writes when its restore did not complete.
  • One place. The installation reference links to the cancel section instead of repeating its mechanism; duplicated mechanism sentences leave the quickstart, calibration step 5 and the warmup script docstring; both templates state that the warmup stays off until calibration.
  • Operator view. runtime/host/operator_view.lines appends rollout.SWITCH_NEXT, so a group member's Model switch: ... | next: names the same action as root status rather than a shorter paraphrase.

Compatibility

  • One behavior change: the operator view's switch line now reads | next: sudo sparkring install --cancel stops it and records it cancelled, or install that model again to resume it instead of | next: an operator's sudo sparkring install --cancel.
  • scripts/config/*.env.example is regenerated from profiles/*/runtime.env.template; the template edits are comments only. profiles/environment-exports.json baselines are unchanged and the layout check validates them.
  • No record, flag, schema or exit-code change.

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.
  • Not run: live serving and a cancel against Sparks. The behavior change is one status string, and the existing runtime/host/test_cancel.py assertion covers the cancel command name in the operator view.

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).
@FujitsuPolycom
FujitsuPolycom merged commit 9bdba28 into main Nov 2, 2026
10 checks passed
@FujitsuPolycom
FujitsuPolycom deleted the prose-standard branch November 2, 2026 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant