Skip to content

Comments

docs: align README/features CLI examples with args.py#29

Open
Taskrwu wants to merge 1 commit intosgl-project:mainfrom
Taskrwu:docs/cli-examples
Open

docs: align README/features CLI examples with args.py#29
Taskrwu wants to merge 1 commit intosgl-project:mainfrom
Taskrwu:docs/cli-examples

Conversation

@Taskrwu
Copy link

@Taskrwu Taskrwu commented Dec 21, 2025

This PR fixes inconsistencies between documentation examples and the actual CLI argument names defined in python/minisgl/server/args.py.

Changes:

  • README.md: Updated --model ~ --model-path, --tp ~ --tp-size, --shell ~ --shell-mode, --cache ~ --cache-type
  • docs/features.md: Same parameter name updates, plus a note about --attn CLI limitation

No code changes, documentation only. All examples should now work when copy-pasted.

@DarkSharpness
Copy link
Collaborator

Thanks. Actually Python argparse allows abbreviation for arguments, so simply passing --tp instead of full name --tp-size is ok. Personally, I prefer the shorter arg name (--tp), which is relatively easier to remember as long as there's no ambiguity.

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.

2 participants