ManPage.md: mlpstorage status and submit — OPTIONS sections, Submission Workflow rewrite, FILES entries for the package and ledger (status-and-submit PR 4) - #882
Merged
Conversation
…lumn, FILES entries for the package and ledger (RED; status-and-submit PR 4)
…on Workflow rewrite, runs list SUBMIT column, post-run status table, FILES entries for the package and ledger (status-and-submit PR 4)
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
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.
Fourth and last PR of the
status/submitseries (#879 vocabulary + readiness evaluator, #880mlpstorage status, #881mlpstorage submit). Docs only:ManPage.mdcatches up with what the three code PRs shipped.--help_allalready carried the STATUS and SUBMIT blocks (the parity test forced them in with the code), so this PR is the man page.What changes in
ManPage.mdmlpstorage status [OPTIONS]andmlpstorage submit [--dry-run] [--out PATH]added besideruns.runs_per_resultfromeditions.yaml). Steps 3–6 are now: run until the result is complete (the post-runstatusrow showsRUNS n/mafter every run), fill in the paperwork,mlpstorage statusuntil every result isready,mlpstorage submit --dry-runthensubmit. Thecode/bullet (stale since the code-image pool) becomescode-images/.validateis named as the reviewer's tool over the same checker.short>invalid>paperwork>ready,-whatif), the five per-run tokens, paperwork-vs-rerun as the severity axis, which rule IDs are folded into RUNS and intosubmit's regeneration step, every flag, the--jsonshape.<org>/{closed,open}/<org>/**+ referenced images under<org>/code-images/, neverwhatif/,.mlps/, the sentinel or orphan images; dry-run output; tarball +.sha256+.manifest.jsonschemamlps-submission-package/1with the key list;.mlps/submissions.jsonlevent shape; manual upload per Submission_guidelines §11),--dry-run/--outsemantics, exit status. States that there is no--force.submitfield (-/?/nullcases)..mlps/submissions.jsonland.mlps/packages/in the tree; "nothing under.mlps/is ever packaged".status/submitrun the same checker in-process; one implementation of every rule.statustable (stdout, after metadata + log detach, skipped under--quiet, never changes the exit code) documented next to the stderr recap.submitrefusal = 1,statusalways 0; a status→submit example; FILES entries for the ledger and the package + manifest; Submission_guidelines §11 pointer.Tests
tests/unit/test_submit_command.py::TestManPage(6 tests, RED first in the first commit): SYNOPSIS + tree entries, the Status section names every flag and all nine tokens plusruns_per_resultandNext:, the Submit section names--dry-run/--out/reportgen/sidecars/ledger/code-images/whatif/--force/exit, FILES has the ledger + package + schema entries, the workflow ends instatusandsubmit, the Runs section mentions SUBMIT.All four CI suites green locally (
tests,mlpstorage_py/tests,vdb_benchmark/tests,kv_cache_benchmark/tests). No code change, no validator change, so no validator-diff run.Reviewable calls
code-images/(Rules.md 2.1.6) instead ofcode/with the MD5 sentence.Submission_guidelines.md§11.1 still sayscode— left alone here (that file is the WG's, and the ManPage points at §11 only for the upload UI).submitis described as recorded in.mlps/history(it is:main.pyrecords every writer; onlyhistory,runs,statusare skipped).2/2 invalid(both phases counted, plus a failed run to remove), which is howreadinessscores that case.