-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
[Misc] Use collapsible blocks for benchmark examples. #20017
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Misc] Use collapsible blocks for benchmark examples. #20017
Conversation
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @reidliu41, 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 improving the user experience and organization of the benchmark documentation. By implementing collapsible sections for various benchmark examples, the PR makes the benchmarks/README.md
file more concise and easier to digest, allowing users to quickly access the specific information they need without excessive scrolling.
Highlights
- Documentation Enhancement: Converted extensive benchmark example sections within
benchmarks/README.md
into interactive, collapsible blocks using native HTML<details>
and<summary>
tags. This significantly improves the readability and navigability of the documentation. - Readability and Formatting: Restructured various sub-headings within the benchmark examples from Markdown headings (
##
or###
) to bold text (**
) to integrate them seamlessly into the collapsible summaries and their content, maintaining a clean and consistent visual hierarchy. - User Experience: Added relevant emojis (e.g., 🚀, 📈, 🛠️) to the summary titles of the main collapsible sections, providing quick visual cues for users to identify and navigate to specific benchmark examples.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The changes in this pull request involve updating the benchmarks README to use collapsible blocks for benchmark examples, enhancing the document's structure and readability.
hi @ywang96 could you please take a look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
Signed-off-by: reidliu41 <[email protected]>
0d21ab6
to
d987c0e
Compare
hi team, can you help to take a look? |
@DarkLight1337 can you help to take a look this? |
…0017) Signed-off-by: reidliu41 <[email protected]> Co-authored-by: reidliu41 <[email protected]>
Essential Elements of an Effective PR Description Checklist
supported_models.md
andexamples
for a new model.Purpose
For #19893 (review)
Test Plan
Test Result
(Optional) Documentation Update