[router] add basic usage doc #8640
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @slin1237, 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!
I've updated the sgl-router documentation to include basic usage instructions for launching the router. This enhancement aims to provide users with clear, actionable examples for both standard and prefill-decode operational modes, making it easier to set up and run the router.
Highlights
- Basic Router Launch Documentation: I've added a new section to the
sgl-router/README.mdthat provides clear instructions and an example command for launching the router in its standard mode using worker URLs. - Prefill-Decode Mode Launch Documentation: I've included a detailed new section in the
sgl-router/README.mdthat explains how to launch the router in 'prefill-decode mode,' complete with a comprehensive example demonstrating the necessary command-line arguments for disaggregation, policy, and specifying multiple prefill and decode nodes.
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 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 or fill out our survey 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 adds basic usage documentation for the sgl-router. The new documentation covers launching the router in both regular and prefill-decode disaggregated modes. My review focuses on the clarity and correctness of the added documentation. I've pointed out a potentially misleading comment in the usage examples to improve clarity for users.
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Motivation
add basic usage doc
Modifications
Accuracy Test
Benchmark & Profiling
Checklist