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

[CI/Build] Unpin outlines #4558

Closed
wants to merge 2 commits into from
Closed

Conversation

br3no
Copy link
Contributor

@br3no br3no commented May 2, 2024

Unpin the outlines dependency.

FIX #4153

Since work on #4109 will take a bit longer...

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!

@simon-mo
Copy link
Collaborator

simon-mo commented May 2, 2024

I think the reason for the pin is exactly the error here in test...


_________ ERROR collecting tests/entrypoints/test_guided_processors.py _________
--
  | ImportError while importing test module '/vllm-workspace/tests/entrypoints/test_guided_processors.py'.
  | Hint: make sure your test modules/packages have valid Python names.
  | Traceback:
  | /usr/lib/python3.10/importlib/__init__.py:126: in import_module
  | return _bootstrap._gcd_import(name[level:], package, level)
  | entrypoints/test_guided_processors.py:8: in <module>
  | from vllm.model_executor.guided_decoding import (
  | /usr/local/lib/python3.10/dist-packages/vllm/model_executor/guided_decoding/__init__.py:5: in <module>
  | from vllm.model_executor.guided_decoding.lm_format_enforcer_decoding import (
  | /usr/local/lib/python3.10/dist-packages/vllm/model_executor/guided_decoding/lm_format_enforcer_decoding.py:15: in <module>
  | from vllm.model_executor.guided_decoding.outlines_decoding import (
  | /usr/local/lib/python3.10/dist-packages/vllm/model_executor/guided_decoding/outlines_decoding.py:15: in <module>
  | from vllm.model_executor.guided_decoding.outlines_logits_processors import (
  | /usr/local/lib/python3.10/dist-packages/vllm/model_executor/guided_decoding/outlines_logits_processors.py:24: in <module>
  | from outlines.fsm.fsm import CFGFSM, FSM, RegexFSM
  | E   ImportError: cannot import name 'FSM' from 'outlines.fsm.fsm' (/usr/local/lib/python3.10/dist-packages/outlines/fsm/fsm.py)


@br3no
Copy link
Contributor Author

br3no commented May 3, 2024

I have removed the FSM import that made this particular test fail.

The thing is that the underlying implementation is the same as with the Guide interface and the issue reported in outlines-dev/outlines#856 will break tests again.

I'm afraid we'll have to wait for this issue to be fixed.

I'm inclined to close this PR...

@saattrupdan
Copy link

I have removed the FSM import that made this particular test fail.

The thing is that the underlying implementation is the same as with the Guide interface and the issue reported in outlines-dev/outlines#856 will break tests again.

I'm afraid we'll have to wait for this issue to be fixed.

I'm inclined to close this PR...

There are several of us who are not using the vllm implementation of outlines, but we are merely using standard vllm with the JSONLogitsProcessor from outlines directly - this works perfectly fine. I don't really see why vllm needs its own "copy" of the outlines code, rather than just importing it? In any case, I would be perfectly happy if all imports from outlines in the vllm code could be packed away in a function, since that's what's blocking me right now.

@br3no
Copy link
Contributor Author

br3no commented May 3, 2024

It's up for the maintainers of vLLM to decide what exactly is to be done here.

We can:

  1. wait for Endless generation bug popped up during migration to Guide in vLLM integration outlines-dev/outlines#856 to be fixed and only then unpin outlines
  2. unpin outlines and disable the failing test (this is a regression) and re-enable the test once the issue above is fixed
  3. make the dependency of outlines optional (@saattrupdan if you feel strongly about this, then I would recommend you open a PR for it...)

@simon-mo
Copy link
Collaborator

simon-mo commented May 3, 2024

I don't really see why vllm needs its own "copy" of the outlines code, rather than just importing it?

This is recommended by the outlines maintainers for us to maintain the logits processor interface and keep the interface between libraries at the FSM/Guide level.

@simon-mo
Copy link
Collaborator

simon-mo commented May 3, 2024

Hmmm. It's generating '3.5.0.10653515246264', maybe tune the temperature or prompting?
https://buildkite.com/vllm/ci/builds/6481#018f3d50-d8eb-4258-8260-ef486c1466ca/51-578

@br3no
Copy link
Contributor Author

br3no commented May 4, 2024

@simon-mo that’s the regression described in outlines-dev/outlines#856. This is a bug in outlines.

We can either disable the test, or wait for the fix, as I listed above.

@br3no
Copy link
Contributor Author

br3no commented May 10, 2024

I have identified the source of the problem in outlines and am waiting for a PR (outlines-dev/outlines#874) to get merged with the fix. Once this is done, we can move on with the migration to the Guide API.

I'll close this PR in favor of #4109.

@br3no br3no closed this May 10, 2024
@rlouf
Copy link

rlouf commented May 11, 2024

I merged the PR that fixes outlines-dev/outlines#874. Indeed @saattrupdan I think it makes more sense to have the processors in vLLM so Outlines is not concerned with details of the implementation and can focus on structured generation alone.

@saattrupdan
Copy link

Indeed @saattrupdan I think it makes more sense to have the processors in vLLM so Outlines is not concerned with details of the implementation and can focus on structured generation alone.

Ah, so the plan is to remove the vLLM integration from the outlines code, and instead ask users to use the one in vLLM?

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.

[Feature]: No outlines strong dependency
4 participants