Renames SRT to SGLang for clarity#125
Conversation
Updates the documentation to consistently use "SGLang" instead of "SRT (SGLang)" when referring to the SGLang runtime. This change aims to improve clarity and avoid confusion by using the official name of the runtime. Signed-off-by: Xinyuan Tong <justinning0323@outlook.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @JustinTong0323, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the clarity and consistency of our documentation by standardizing the naming convention for SGLang Runtimes. The change ensures that the documentation accurately reflects the intended terminology, making it easier for users to understand and refer to the serving runtimes.
Highlights
- Documentation Clarity: Updates instances of 'SRT (SGLang) Runtimes' to 'SGLang Runtimes' for improved consistency and clarity in the serving runtime documentation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request aims to improve documentation clarity by renaming 'SRT (SGLang) Runtimes' to 'SGLang Runtimes'. The change is a good step towards removing redundancy. I've suggested one improvement to further enhance clarity by using the full 'SGLang Runtime' name instead of just 'SGLang' in the note, based on the information provided in the pull request description. This will ensure the documentation is as unambiguous as possible for users.
| ### SGLang Runtimes | ||
|
|
||
| > **Note:** SRT (SGLang) is our flagship supporting runtime, offering the latest serving engine with the most optimal performance. It provides cutting-edge features including multi-node serving capabilities, prefill-decode disaggregated serving, and Large-scale Cross-node Expert Parallelism (EP) for optimal performance at scale. | ||
| > **Note:** SGLang is our flagship supporting runtime, offering the latest serving engine with the most optimal performance. It provides cutting-edge features including multi-node serving capabilities, prefill-decode disaggregated serving, and Large-scale Cross-node Expert Parallelism (EP) for optimal performance at scale. |
There was a problem hiding this comment.
While simplifying SRT (SGLang) is a good step, replacing it with just SGLang might be ambiguous. According to the PR description, 'SRT' is an abbreviation for 'SGLang Runtime'. To be perfectly clear and consistent, it would be better to use the full name 'SGLang Runtime' in the documentation, especially since this is a flagship feature.
| > **Note:** SGLang is our flagship supporting runtime, offering the latest serving engine with the most optimal performance. It provides cutting-edge features including multi-node serving capabilities, prefill-decode disaggregated serving, and Large-scale Cross-node Expert Parallelism (EP) for optimal performance at scale. | |
| > **Note:** SGLang Runtime is our flagship supporting runtime, offering the latest serving engine with the most optimal performance. It provides cutting-edge features including multi-node serving capabilities, prefill-decode disaggregated serving, and Large-scale Cross-node Expert Parallelism (EP) for optimal performance at scale. |
2 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
As "SRT" is already the abbreviation for "SGLang Runtime", this PR updates the documentation to consistently use "SGLang Runtimes" instead of "SRT (SGLang) Runtimes".
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?