chore(config): strip _comment_*/_example_* clutter now that cvs man documents these - #346
Open
speriaswamy-amd wants to merge 2 commits into
Conversation
…ocuments these AIMVT-276
…aged edits The prior commit's git add ran before the last two manual conflict resolutions on these upstream-diverged files, so it captured a partially stripped intermediate state. AIMVT-276
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.
Part 13 of 14 in a stack for AIMVT-276.
Base: #345.
Why
cvs man(parts 9-12) now generates parameter docs directly from thepydantic schemas, so the hand-maintained
_comment_*/_example_*keys inthe shipped sample configs and the duplicated parameter tables in
README_preflight_config.mdare a second, driftable source of truth forthe four suites this ticket documents (rccl, health, megatron, preflight).
No code path reads these keys for behavior — they are only skipped/ignored
by the config loader — so this is a pure documentation cutover; existing
customer configs that still contain the old keys continue to work
unmodified.
What changed
_comment_*/_example_*keys from the four pilot suites'sample JSON configs:
rccl_config.json,mi300_health_config.json, thethree megatron JSONs, and
preflight_config.json(including thenode_smokeblock added upstream after this ticket's fork point, nowdocumented by
PreflightNodeSmokeConfiginschemas.py). Manual setupinstructions under
node_smoke(_setup_comment,_setup_step_*,_setup_note) are preserved as-is — they're procedural, not per-field docs.docs/reference/configuration-files/health.rstandmegatron.rst, andfrom
README_preflight_config.md(thefabric_checks/node-smoke/reporting sections upstream had added since this ticket's fork point,
now fully covered by
cvs man preflight_checks), pointing readers atcvs maninstead.config_registry.py(rccl, health,megatron, preflight). Other suites with leftover
_comment_*/_example_*keys (platform, ibperf, ompi, inference, jax, torchtitan, mori, anc) have
no pydantic schema yet and are out of scope for this pilot.