Fix stale command examples in cifar and cvae READMEs - #1431
Open
ZayanKhan-12 wants to merge 2 commits into
Open
Conversation
main.py's argparse defines --batch_size (main.py line 19); the documented mlx.launch command fails with 'unrecognized arguments: --batch 256' as written. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The training entry point is main.py (train.py does not exist in this example); the README's own earlier instructions already say 'python main.py'. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Two documented commands don't match the code, one commit each:
main.py --batch 256 --epochs 5 --arch resnet20, butmain.py's parser defines--batch_size— the command fails withunrecognized arguments: --batch 256. Verified by runningmain.py --help(parser output lists--batch_size; no--batch).$ python train.py, but the example's entry point ismain.py(train.pydoesn't exist in the directory; the README's own instructions above saypython main.py).Both scripts still compile (
python -m py_compile). A sweep of every other example README's documented flags against each script's argparse definitions found no further mismatches.Prepared with AI assistance (Claude); both fixes mechanically verified as described.