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] OpenAI entrypoint limits logprobs while ignoring server defined --max-logprobs #5312

Merged
merged 7 commits into from
Jun 11, 2024

Conversation

maor-ps
Copy link
Contributor

@maor-ps maor-ps commented Jun 6, 2024

Current check implementation disregards the server parameters --max-logprobs and restricts the logprobs returned from the server. This modification removes the upper limit and ensures that the logprobs values are only checked to be positive integers.

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!

Current check implementation disregards the server parameters --max-logprobs and restricts the logprobs returned from the server. This modification removes the upper limit and ensures that the logprobs values are only checked to be positive integers.
@maor-ps maor-ps changed the title [Bugfix] logprobs should not be limited by client. [Bugfix] OpenAI entrypoint limits logprobs while ignoring server defined --max-logprobs Jun 6, 2024
@simon-mo
Copy link
Collaborator

simon-mo commented Jun 6, 2024

cc @robertgshaw2-neuralmagic

I believe this is partly intentional to (1) cap the memory usage (2) follow OpenAI's convention. But we should still allow the cap to be configurable.

@maor-ps
Copy link
Contributor Author

maor-ps commented Jun 6, 2024

cc @robertgshaw2-neuralmagic

I believe this is partly intentional to (1) cap the memory usage (2) follow OpenAI's convention. But we should still allow the cap to be configurable.

@simon-mo
The capping is already handled on the vllm side when running the server, with the default max-logprobs set to 5. If the OpenAI entrypoint requests a larger number, vllm will throw an error.

@simon-mo simon-mo enabled auto-merge (squash) June 6, 2024 11:28
auto-merge was automatically disabled June 6, 2024 12:05

Head branch was pushed to by a user without write access

@DarkLight1337
Copy link
Member

OpenAI's Chat Completion API supports up to top_logprobs=20 (as opposed to logprobs=5 for legacy Completion API). Should we increase the default ModelConflig.max_logprobs accordingly?

@DarkLight1337
Copy link
Member

Since max_logprobs only imposes a limit on the user, it should be fine to increase the default value. I have pushed a commit that increases max_logprobs to the value required by Chat Completions API.

@DarkLight1337 DarkLight1337 merged commit 351d5e7 into vllm-project:main Jun 11, 2024
103 checks passed
tjohnson31415 added a commit to tjohnson31415/vllm that referenced this pull request Jun 11, 2024
* upstream/main: (126 commits)
  [Bugfix][Frontend] Cleanup "fix chat logprobs" (vllm-project#5026)
  [Bugfix] OpenAI entrypoint limits logprobs while ignoring server defined --max-logprobs (vllm-project#5312)
  [Misc] Various simplifications and typing fixes (vllm-project#5368)
  [ci] Fix Buildkite agent path (vllm-project#5392)
  [Doc] Add documentation for FP8 W8A8 (vllm-project#5388)
  Bump version to v0.5.0 (vllm-project#5384)
  [Docs] Alphabetically sort sponsors (vllm-project#5386)
  [Docs] Add Docs on Limitations of VLM Support (vllm-project#5383)
  [ci] Mount buildkite agent on Docker container to upload benchmark results (vllm-project#5330)
  [ci] Use small_cpu_queue for doc build (vllm-project#5331)
  [Bugfix] Fix LLaVA-NeXT (vllm-project#5380)
  [Feature][Frontend]:  Continued `stream_options` implementation also in CompletionRequest (vllm-project#5319)
  [Model] Initial support for LLaVA-NeXT (vllm-project#4199)
  [Misc] Improve error message when LoRA parsing fails (vllm-project#5194)
  [misc][typo] fix typo (vllm-project#5372)
  [Frontend][Misc] Enforce Pixel Values as Input Type for VLMs in API Server (vllm-project#5374)
  [Misc] Update to comply with the new `compressed-tensors` config (vllm-project#5350)
  [Bugfix] Fix KeyError: 1 When Using LoRA adapters (vllm-project#5164)
  [Kernel][Misc] Use TORCH_LIBRARY instead of PYBIND11_MODULE for custom ops (vllm-project#5047)
  [mis][ci/test] fix flaky test in test_sharded_state_loader.py (vllm-project#5361)
  ...
robertgshaw2-neuralmagic pushed a commit to neuralmagic/nm-vllm that referenced this pull request Jun 12, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
joerunde pushed a commit to joerunde/vllm that referenced this pull request Jun 17, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jun 27, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jul 8, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jul 24, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
…ned --max-logprobs (vllm-project#5312)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
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.

None yet

3 participants