-
Notifications
You must be signed in to change notification settings - Fork 14
Alias flashinfer_bench as fib in README #94
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
Conversation
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.
Pull Request Overview
This PR updates the README to alias the flashinfer_bench import as fib and adds Bosch as a collaborator.
- Adds import alias
fibforflashinfer_benchin the installation example - Adds Bosch logo to the collaborators section
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Summary of ChangesHello @Ubospica, 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 refines the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughUpdated README.md: usage example now imports Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Comment |
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
This pull request introduces two changes to the README.md file. First, it adds fib as a recommended alias for flashinfer_bench. Second, it adds Bosch to the list of collaborators. My review focuses on improving the clarity of the documentation. I've suggested adding a usage example for the new fib alias to make the README more helpful for new users.
|
|
||
| ```python | ||
| import flashinfer_bench | ||
| import flashinfer_bench as fib |
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.
While aliasing flashinfer_bench to fib is a good practice for brevity, the alias is not used in any example within this README. To make this initial example more illustrative and provide a more complete 'get started' experience, consider adding a small code snippet that demonstrates the usage of the fib alias. For example, you could show how to access the version number.
| import flashinfer_bench as fib | |
| import flashinfer_bench as fib | |
| # Get the version of flashinfer_bench | |
| print(fib.__version__) |
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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
README.md (1)
29-29: Import alias aligns with PR objective.The change to alias
flashinfer_benchasfibis a clean, straightforward update that matches the stated PR goal and improves brevity in usage examples.
|   | ||
| [<img src="https://raw.githubusercontent.com/mlc-ai/XGrammar-web-assets/refs/heads/main/repo/vllm.png" height=50/>](https://github.com/vllm-project/vllm) | ||
|   | ||
| [<img src="https://raw.githubusercontent.com/mlc-ai/XGrammar-web-assets/refs/heads/main/repo/bosch.svg" height=50/>](https://www.bosch.com/) |
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.
Add alt text to the Bosch logo image.
The image element is missing the alt attribute, which is required for accessibility and Markdown linting compliance.
Apply this diff to add alt text:
-[<img src="https://raw.githubusercontent.com/mlc-ai/XGrammar-web-assets/refs/heads/main/repo/bosch.svg" height=50/>](https://www.bosch.com/)
+[<img src="https://raw.githubusercontent.com/mlc-ai/XGrammar-web-assets/refs/heads/main/repo/bosch.svg" alt="Bosch" height=50/>](https://www.bosch.com/)🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In README.md around line 56, the Bosch logo image tag is missing an alt
attribute; update the Markdown image HTML to include a descriptive alt text (for
example alt="Bosch logo") so the <img> element becomes accessible and
linter-compliant, keeping the existing src, link, and height unchanged.
Summary by CodeRabbit