vllm icon indicating copy to clipboard operation
vllm copied to clipboard

[Frontend][Core] Update Outlines Integration from `FSM` to `Guide`

Open br3no opened this issue 4 months ago • 6 comments

This PR updates the Outlines Integration from FSM to the new Guide interface.

Since I'm not sure where to place the change, I added both labels [Frontend] and [Core].

FIX #3715

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!

br3no avatar Apr 16 '24 08:04 br3no

I think the test failure in the entrypoints test might be related, and there's merge conflict. 🙏

simon-mo avatar Apr 18 '24 07:04 simon-mo

I'll have a look at the failing frontend test.

br3no avatar Apr 18 '24 12:04 br3no

I can reproduce the error in the test on my dev environment. The generation does not stop when it should, generating IP addresses like this: 100.101.102.10319216. I'm investigating why this happens and reached out to @rlouf in the outlines discord.

I have pushed some small improvements to the test code:

  • ~corrected the regex for IPv4~ the regex was correct. I reverted the change
  • changed the pytest fixture to make sure the same python interpreter is used when starting the vLLM server for the integration test (see the warning box here: https://docs.python.org/3/library/subprocess.html#subprocess.Popen)

br3no avatar Apr 19 '24 19:04 br3no

hey @br3no @simon-mo any updates on getting this PR merged? The pinned version of outlines is preventing us from picking up a bug fix in included in 0.0.40. Is there anyway we can pull the relaxed version constraint into it's own PR to unblock?

navster888 avatar Apr 29 '24 17:04 navster888

I'm having a call with outlines contributors on Thursday. While there is no guarantee we will have a solution for the problem, I'd propose to wait until then. If there's no progress by the end of the week, I'd open a separate PR for the unpinning.

What do you think?

br3no avatar Apr 30 '24 17:04 br3no

I have opened #4558 because moving to the Guide API will require https://github.com/outlines-dev/outlines/issues/856 to be fixed first.

br3no avatar May 02 '24 12:05 br3no

I have closed #4558 in favor of this PR. I expect to make progress on this next week. Waiting for https://github.com/outlines-dev/outlines/pull/874.

br3no avatar May 10 '24 15:05 br3no

https://github.com/outlines-dev/outlines/pull/874 merged, thank you for your patience!

rlouf avatar May 11 '24 20:05 rlouf

Great, thanks for the support @rlouf!

Can you tell already when you plan to release?

br3no avatar May 12 '24 19:05 br3no

Next week I think. I need to make sure other downstream libraries have pinned the outlines version to avoid surprises.

rlouf avatar May 19 '24 11:05 rlouf