Skip to content

cli: document --checkpoint-subset in the --help_all reference - #844

Merged
FileSystemGuy merged 2 commits into
mainfrom
help-all-checkpoint-subset
Aug 11, 2026
Merged

cli: document --checkpoint-subset in the --help_all reference#844
FileSystemGuy merged 2 commits into
mainfrom
help-all-checkpoint-subset

Conversation

@FileSystemGuy

Copy link
Copy Markdown
Contributor

What

--checkpoint-subset (added to the parser in 828cc63, #841 subset gating) was present in the real argparse help but missing from the --help_all command reference — that page is hand-curated in mlpstorage_py/cli/help_formatter.py, not generated from argparse, so a parser-only change silently omits new flags.

Changes

  • RED (5898384): test_help_all_documents_checkpoint_subset — asserts the flag appears in --help_all output.
  • GREEN (f950b91): one line in CK_RUN_CLOSED's Optional block, annotated (8B at 8 processes only; declares a Subset run) per Rules.md 4.3.5. CK_RUN_OPEN/CK_RUN_WHATIF inherit it via the = CK_RUN_CLOSED plus: notation.

All 54 help-behavior tests pass. A broader audit of every CLI argument against all help surfaces is planned as a follow-up.

The curated reference in help_formatter.py is hand-maintained, not
generated from argparse; 828cc63 added the flag to the parser only,
so --help_all silently omits it.
…rence

Added to CK_RUN_CLOSED's Optional block (CK_RUN_OPEN/WHATIF inherit via
'= CK_RUN_CLOSED plus:'), annotated '8B at 8 processes only; declares a
Subset run' consistent with Rules.md 4.3.5 and check_subset_mode.
@FileSystemGuy
FileSystemGuy requested a review from a team August 11, 2026 21:27
@github-actions

Copy link
Copy Markdown

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@FileSystemGuy
FileSystemGuy merged commit fa15d81 into main Aug 11, 2026
4 checks passed
@FileSystemGuy
FileSystemGuy deleted the help-all-checkpoint-subset branch August 11, 2026 21:30
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