Skip to content

Add chat doc in quick start #21213

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 3, 2025
Merged

Add chat doc in quick start #21213

merged 5 commits into from
Aug 3, 2025

Conversation

TankNee
Copy link
Contributor

@TankNee TankNee commented Jul 19, 2025 •
edited by github-actions bot
Loading

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

Add documentation about the chat interface to the quickstart guide to align with OpenAI's chat/completions API and prevent unexpected behavior when using the generate method with chat models.

Test Plan

Test Result

(Optional) Documentation Update

@TankNee TankNee requested a review from hmellor as a code owner July 19, 2025 02:52
@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

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 either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Jul 19, 2025
gemini-code-assist[bot]
gemini-code-assist bot reviewed Jul 19, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a helpful note and code examples to the quickstart guide on how to use chat models with vLLM. The explanation is clear and valuable for users. I've found a bug in one of the new code examples and provided a suggestion to fix it. Once that's addressed, this should be good to merge.

DarkLight1337
DarkLight1337 reviewed Jul 20, 2025
View reviewed changes
DarkLight1337
DarkLight1337 reviewed Jul 20, 2025
View reviewed changes
DarkLight1337
DarkLight1337 reviewed Jul 20, 2025
View reviewed changes
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for improving the docs! Some suggestions

TankNee and others added 2 commits August 3, 2025 22:29
@TankNee @DarkLight1337
Update docs/getting_started/quickstart.md
0f57d6f 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
@TankNee
add ??? code
c177d44
DarkLight1337
DarkLight1337 reviewed Aug 3, 2025
View reviewed changes
@TankNee
Copy link
Contributor Author

TankNee commented Aug 3, 2025

@DarkLight1337 I made some changes to the document based on your suggestions, and it does look neater and more readable now.

DarkLight1337
DarkLight1337 approved these changes Aug 3, 2025
View reviewed changes
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating!

@vllm-bot vllm-bot merged commit 83f7bbb into vllm-project:main Aug 3, 2025
6 of 9 checks passed
juuice-lee pushed a commit to juuice-lee/vllm-moe.code that referenced this pull request Aug 5, 2025
@TankNee @DarkLight1337
Add chat doc in quick start (vllm-project#21213)
19a015c 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
@TankNee @DarkLight1337 @x22x22
Add chat doc in quick start (vllm-project#21213)
e18dabc 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
@TankNee @DarkLight1337 @x22x22
Add chat doc in quick start (vllm-project#21213)
3ab43aa 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: x22x22 <wadeking@qq.com>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
@TankNee @DarkLight1337 @x22x22
Add chat doc in quick start (vllm-project#21213)
729a8d0 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: x22x22 <wadeking@qq.com>
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
@TankNee @DarkLight1337 @npanpaliya
Add chat doc in quick start (vllm-project#21213)
b686e35 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
jingyu-ml pushed a commit to jingyu-ml/vllm that referenced this pull request Aug 8, 2025
@TankNee @DarkLight1337
Add chat doc in quick start (vllm-project#21213)
cb917d4 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: jingyu <jingyu@omniml.ai>
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
@TankNee @DarkLight1337 @jinzhen-lin
Add chat doc in quick start (vllm-project#21213)
2f2a07f 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
noamgat pushed a commit to noamgat/vllm that referenced this pull request Aug 9, 2025
@TankNee @DarkLight1337 @noamgat
Add chat doc in quick start (vllm-project#21213)
bb5385e 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Noam Gat <noamgat@gmail.com>
yyihuang pushed a commit to yyihuang/vllm that referenced this pull request Aug 11, 2025
@TankNee @DarkLight1337 @yyihuang
Add chat doc in quick start (vllm-project#21213)
5851673 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Avery Yingyi Huang <yingyihuang2000@outlook.com>
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
@TankNee @DarkLight1337 @paulpak58
Add chat doc in quick start (vllm-project#21213)
d8c0592 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Paul Pak <paulpak58@gmail.com>
taneem-ibrahim pushed a commit to taneem-ibrahim/vllm that referenced this pull request Aug 14, 2025
@TankNee @DarkLight1337 @taneem-ibrahim
Add chat doc in quick start (vllm-project#21213)
b484dab 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
BoyuanFeng pushed a commit to BoyuanFeng/vllm that referenced this pull request Aug 14, 2025
@TankNee @DarkLight1337 @BoyuanFeng
Add chat doc in quick start (vllm-project#21213)
6f3aac4 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Boyuan Feng <boyuan@meta.com>
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
@TankNee @DarkLight1337 @diegocastanibm
Add chat doc in quick start (vllm-project#21213)
21b3ef8 
Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com>
Signed-off-by: Diego-Castan <diego.castan@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

@hmellor hmellor Awaiting requested review from hmellor hmellor is a code owner

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@TankNee @DarkLight1337 @vllm-bot