Fix documentation gaps on main README#373
Open
idevasena wants to merge 1 commit into
Open
Conversation
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
FileSystemGuy
approved these changes
May 13, 2026
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
2 participants
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.
Summary
Fixes #350.
Documents the
--file/--objectbackend-selector flags and the--allow-run-as-rootMPI flag inREADME.md, and refreshes the stale top-level CLI help block and missing workload sections that surfaced while addressing the issue.Similarly, root users hit
mpirun has detected an attempt to run as rootwith--allow-run-as-rootonly visible inside--helpoutput, never in prose or examples.Changes
All edits are to
README.md:Refresh top-level CLI help block + add "Running as root" callout under Prerequisite.
Replace the stale
{training,checkpointing,vectordb,reports,history}output with the current{training,checkpointing,vectordb,kvcache}output. Add a short subsection explaining when--allow-run-as-rootis required (containerized / bare-metal root launchers) with one example.Add "Storage Backend Selection (
--file/--object)" subsection under Operation.Single source of truth for both
checkpointing runandkvcache run. Documents that the flags are mutually exclusive, one is required, and what each backend maps to (POSIX/parallel FS vs. S3-compatible object store via the three supported object-store libraries).