Skip to content
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

[Bugfix] Reenable LRU cache on Outlines' guide getters #8308

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Lap1n
Copy link

@Lap1n Lap1n commented Sep 9, 2024

In our setup, vLLM's structured generation became 2x slower from 0.5.2 to 0.5.3.

The regression was introduced with this commit. I replaced the LRUCache annotation on the _get_guide function of the LogitsProcessor in favor of the @cache implementation from Outlines, so the cache function outputs can be reused across startup. However, this seems to have a significant impact on performance as Outlines' diskcache-based implementation doesn't seem as fast.

This PR adds back the LRUCache on top of the Outlines one fixes this performance issue.

FIX #8307 (link existing issues this PR will resolve)

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE


PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
  • [Kernel] for changes affecting CUDA kernels or other compute kernels.
  • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

Copy link

github-actions bot commented Sep 9, 2024

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@Lap1n Lap1n changed the title Fix/renable lru cache outlines [Bugfix] Renable lru cache outlines Sep 9, 2024
@Lap1n Lap1n changed the title [Bugfix] Renable lru cache outlines [Bugfix] Renable LRU cache on Outlines' guide getters Sep 9, 2024
@Lap1n Lap1n marked this pull request as ready for review September 9, 2024 20:55
@Lap1n Lap1n changed the title [Bugfix] Renable LRU cache on Outlines' guide getters [Bugfix] Reenable LRU cache on Outlines' guide getters Sep 10, 2024
@stas00
Copy link
Contributor

stas00 commented Sep 11, 2024

I think other methods need caching as well - perhaps in another PR if it not a regression?

See the first item of #8313 (comment) - it rebuilds the json schema regex on every request!

edit: made a standalone issue #8383 so this doesn't get dropped

@Lap1n
Copy link
Author

Lap1n commented Sep 11, 2024

Nice findings! I guess those changes could be added in another PR. What do you think @robertgshaw2-neuralmagic ?

@akramsystems
Copy link

any updates on this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: Outline performance regression from v0.5.2 to 0.5.3
3 participants