-
Notifications
You must be signed in to change notification settings - Fork 293
Add Grammar Cache for XGrammar Backend #936
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.
Summary of Changes
Hello @flyinglandlord, 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 introduces a significant performance optimization for the XGrammar backend by implementing a caching layer for grammar and JSON schema compilation. By memoizing the results of these compilation processes, the system avoids re-compiling identical grammars or schemas, leading to more efficient processing, especially in scenarios with repetitive grammar usage.
Highlights
- Grammar Compilation Caching: Implemented a caching mechanism using
functools.lru_cacheforxgrammarand JSON schema compilation. This aims to reduce redundant compilation work and improve performance by storing up to 200 recently compiled grammars/schemas. - Refactored Grammar Compilation Logic: Centralized the grammar and JSON schema compilation calls into a new
dispatch_grammarmethod within theinit_customfunction. Existing calls tocompile_grammarandcompile_json_schemain_init_req_xgrammer_matcher_infoshave been updated to utilize this new cached dispatcher.
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 pull request introduces a grammar cache for the XGrammar backend using functools.lru_cache to optimize grammar compilation. The changes involve adding a dispatch_grammar function with caching and updating the _init_req_xgrammer_matcher_infos method to use the cache. I've suggested adding error handling for grammar compilation and considering typed=True for the lru_cache decorator.
lightllm/server/router/model_infer/mode_backend/chunked_prefill/impl_for_xgrammar_mode.py
Outdated
Show resolved
Hide resolved
lightllm/server/router/model_infer/mode_backend/chunked_prefill/impl_for_xgrammar_mode.py
Outdated
Show resolved
Hide resolved
lightllm/server/router/model_infer/mode_backend/chunked_prefill/impl_for_xgrammar_mode.py
Outdated
Show resolved
Hide resolved
| eos_token_ids.append(self.tokenizer.eos_token_id) | ||
| eos_token_ids.extend(self.args.eos_id) | ||
|
|
||
| @functools.lru_cache(maxsize=200) |
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.
The lru_cache decorator is used without specifying a typed=True argument. If the type argument to dispatch_grammar can vary in type but represent the same value (e.g., "grammar" vs str("grammar")), the cache may not function as expected. Consider adding typed=True to the decorator to differentiate cache entries by argument type.
| @functools.lru_cache(maxsize=200) | |
| @functools.lru_cache(maxsize=200, typed=True) | |
| def dispatch_grammar(type: str, grammar: str): |
…l/impl_for_xgrammar_mode.py Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…l/impl_for_xgrammar_mode.py Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
No description provided.