Fix readme critical typos #12
Open
Conversation
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
(`$MODLE_PATH` -> `$MODEL_PATH`)
There was a problem hiding this comment.
Pull Request Overview
This PR corrects critical typos and broken references in the README to improve clarity and accuracy.
- Fixes a misspelled example variable name ($MODLE_PATH -> $MODEL_PATH)
- Updates a broken LICENSE link (master/LICENCE -> main/LICENSE)
- Improves grammar in a training/conversion instruction
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| Models with safetensors format can be downloaded from [HuggingFace](https://huggingface.co/inclusionAI) or [ModelScope](https://modelscope.cn/organization/inclusionAI). | ||
| If you want to train your model and eval it, you can convert from dcp produced by training. | ||
| If you want to train your model and evaluate it, you can convert from dcp produced by training. |
There was a problem hiding this comment.
For consistency with the environment variable DCP_PATH and the script name convert_dcp_to_safe_tensors.py, capitalize 'dcp' as 'DCP'.
Suggested change
| If you want to train your model and evaluate it, you can convert from dcp produced by training. | |
| If you want to train your model and evaluate it, you can convert from DCP produced by training. |
| ```shell | ||
| python -m sglang.launch_server \ | ||
| --model-path $MODLE_PATH \ | ||
| --model-path $MODEL_PATH \ |
There was a problem hiding this comment.
Use braced variable expansion for consistency with ${DCP_PATH} above and to avoid potential parsing issues; change to ${MODEL_PATH}.
Suggested change
| --model-path $MODEL_PATH \ | |
| --model-path ${MODEL_PATH} \ |
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
$MODLE_PATH->$MODEL_PATH)I hope this helps!