vllm
[Misc][OpenAI] deprecate max_tokens in favor of new max_completion_tokens field for chat completion endpoint
#9837
Merged

[Misc][OpenAI] deprecate max_tokens in favor of new max_completion_tokens field for chat completion endpoint #9837

gcalmettes
gcalmettes197 days ago

OpenAI deprecated the max_tokens field in favor of the new max_completion_tokens field for its create chat completion request.

Libraries like Microsoft Semantic-kernel are using the new max_completion_tokens field in their create chat request, leading to a pydantic validation error.

{"object":"error","message":"[{'type': 'extra_forbidden', 'loc': ('body', 'max_completion_tokens'), 'msg': 'Extra inputs are not permitted', 'input': 4096}]","type":"BadRequestError","param":null,"code":400}

This PR marks the max_tokens field as deprecated in the ChatCompletionRequest model (but still supports it) and add the support for the newly max_completion_tokens field, which takes precedence over max_tokens if present in the request.

Tests leveraging create_chat_completion requests have been updated to use the new field.

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.

Adding or changing kernels

Each custom kernel needs a schema and one or more implementations to be registered with PyTorch.

  • Make sure custom ops are registered following PyTorch guidelines: Custom C++ and CUDA Operators and The Custom Operators Manual
  • Custom operations that return Tensors require meta-functions. Meta-functions should be implemented and registered in python so that dynamic dims can be handled automatically. See above documents for a description of meta-functions.
  • Use torch.libary.opcheck() to test the function registration and meta-function for any registered ops. See tests/kernels for examples.
  • When changing the C++ signature of an existing op, the schema must be updated to reflect the changes.
  • If a new custom type is needed, see the following document: Custom Class Support in PT2.

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!

gcalmettes gcalmettes requested a review from DarkLight1337 DarkLight1337 197 days ago
gcalmettes gcalmettes requested a review from robertgshaw2-redhat robertgshaw2-redhat 197 days ago
gcalmettes gcalmettes requested a review from simon-mo simon-mo 197 days ago
github-actions
github-actions197 days ago

πŸ‘‹ 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.

πŸš€

mergify mergify added documentation
mergify mergify added frontend
gcalmettes gcalmettes force pushed 197 days ago
DarkLight1337 DarkLight1337 assigned DarkLight1337 DarkLight1337 197 days ago
DarkLight1337
DarkLight1337197 days ago

Thanks for updating this, what is the minimum openai-python version that is required to use max_completion_tokens?

gcalmettes gcalmettes force pushed 197 days ago
mergify mergify added ci/build
gcalmettes
gcalmettes197 days agoπŸ‘ 1

@DarkLight1337 good catch!

They added the change with version v1.45.0 when they introduced support for the o1 models.

I have added the bump of the openai version to 1.45.0 in the dependencies

gcalmettes gcalmettes force pushed 197 days ago
DarkLight1337
DarkLight1337 commented on 2024-10-30
Conversation is marked as resolved
Show resolved
requirements-common.txt
1111fastapi >= 0.107.0, != 0.113.*, != 0.114.0; python_version >= '3.9'
1212aiohttp
13openai >= 1.40.0 # Ensure modern openai package (ensure types module present)
13
openai >= 1.45.0 # Ensure modern openai package (ensure types module present)
DarkLight1337197 days ago

Can you also update the comment line to reference this change?

gcalmettes197 days ago

good point.
I have updated the comment to reflect the needed minimal version βœ”οΈ

DarkLight1337 DarkLight1337 added ready
DarkLight1337
DarkLight1337 approved these changes on 2024-10-30
DarkLight1337197 days ago

Thanks for updating this!

DarkLight1337 DarkLight1337 enabled auto-merge (squash) 197 days ago
mgoin
mgoin commented on 2024-10-30
Conversation is marked as resolved
Show resolved
vllm/entrypoints/openai/protocol.py
159159 logit_bias: Optional[Dict[str, float]] = None
160160 logprobs: Optional[bool] = False
161161 top_logprobs: Optional[int] = 0
162 max_tokens: Optional[int] = None
162
# TODO: remove max_tokens when field is removed from OpenAI API
mgoin197 days ago

It would be best to tie these todo to an open issue, so all of them can be easily searched. As in "TODO (#XXXX): ..."

gcalmettes197 days ago

Good idea!

I will open an issue and update all the TODO comments.

gcalmettes197 days ago (edited 197 days ago)

@mgoin issue #9845 opened and TODO comments updated to reference it. Thanks for the suggestion ! πŸ‘

disabled auto-merge 197 days ago
Head branch was pushed to by a user without write access
gcalmettes gcalmettes force pushed 197 days ago
gcalmettes feat(openai): add new field max_completion_tokens
389fd9ec
gcalmettes feat: use new max_completion_tokens field for chat_completions calls
c5371927
gcalmettes lint: apply formatting
acac1426
gcalmettes feat: bump openai dependency to version introducing max_completion_to…
cf5041b9
gcalmettes lint: apply yapf
b1621bfe
gcalmettes chore: reflect max_completion_tokens support for minimal openai lib v…
520be809
gcalmettes feat: tie TODO comments to relevant issue for better referencing
aad5b19e
gcalmettes gcalmettes force pushed to aad5b19e 197 days ago
simon-mo simon-mo merged abbfb613 into main 197 days ago

Login to write a write a comment.

Login via GitHub

Assignees
Labels
Milestone