Skip to content

[Doc] Update benchmarks README #14646

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 7 commits into from
Mar 12, 2025
Merged

[Doc] Update benchmarks README #14646

merged 7 commits into from
Mar 12, 2025

Conversation

JenZhao
Copy link
Contributor

@JenZhao JenZhao commented Mar 11, 2025 •
edited by github-actions bot
Loading

Update the benchmarks README to better reflect the latest dataset changes from #14036

@JenZhao
update benchmark readme
6a72151 
Signed-off-by: Jennifer Zhao <[email protected]>
@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.

🚀

ywang96
ywang96 reviewed Mar 12, 2025
View reviewed changes
Copy link
Member

@ywang96 ywang96 left a comment

Choose a reason for hiding this comment

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

Thank you for this PR! I left a few comments.

We should also mention that we have a lot of other benchmark scripts (benchmark_latency.py is an important one coming to mind) that we should call out in the README too!

benchmarks/README.md Outdated
**Note**: VisionArena’s `dataset-name` should be set to `hf`

---
## Online Script Example
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Online Script Example
## Example - Online Benchmark

benchmarks/README.md Outdated

```bash
wget https://huggingface.co/datasets/anon8231489123/ShareGPT_Vicuna_unfiltered/resolve/main/ShareGPT_V3_unfiltered_cleaned_split.json
MODEL_NAME="meta-llama/Llama-3.1-8B-Instruct"
Copy link
Member

Choose a reason for hiding this comment

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

Let's use NousResearch/Hermes-3-Llama-3.1-8B since this model is not gated

benchmarks/README.md Outdated
mkdir coco -p
wget http://images.cocodataset.org/zips/train2017.zip -O coco/train2017.zip
unzip coco/train2017.zip -d coco/
MODEL_NAME="meta-llama/Llama-3.1-8B-Instruct"
Copy link
Member

Choose a reason for hiding this comment

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

Change model name here accordingly

@JenZhao
address comments
3d521af 
Signed-off-by: Jennifer Zhao <[email protected]>
ywang96
ywang96 reviewed Mar 12, 2025
View reviewed changes
ywang96
ywang96 reviewed Mar 12, 2025
View reviewed changes
@JenZhao JenZhao changed the title [Doc] update benchmark readme [Doc] Update benchmarks README Mar 12, 2025
ywang96
ywang96 approved these changes Mar 12, 2025
View reviewed changes
Copy link
Member

@ywang96 ywang96 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for the contribution!

@ywang96 ywang96 added the ready ONLY add when PR is ready to merge/full CI is needed label Mar 12, 2025
@ywang96 ywang96 enabled auto-merge (squash) March 12, 2025 02:13
@WoosukKwon WoosukKwon disabled auto-merge March 12, 2025 02:22
@WoosukKwon WoosukKwon merged commit 4a42b9f into vllm-project:main Mar 12, 2025
11 of 17 checks passed
richardsliu pushed a commit to richardsliu/vllm that referenced this pull request Mar 14, 2025
@JenZhao @ywang96 @richardsliu
[Doc] Update benchmarks README (vllm-project#14646)
5e90b91 
Signed-off-by: Jennifer Zhao <[email protected]>
Co-authored-by: Jennifer Zhao <[email protected]>
Co-authored-by: Roger Wang <[email protected]>
Signed-off-by: Richard Liu <[email protected]>
lulmer pushed a commit to lulmer/vllm that referenced this pull request Apr 7, 2025
@JenZhao @ywang96 @lulmer
[Doc] Update benchmarks README (vllm-project#14646)
a95d12a 
Signed-off-by: Jennifer Zhao <[email protected]>
Co-authored-by: Jennifer Zhao <[email protected]>
Co-authored-by: Roger Wang <[email protected]>
Signed-off-by: Louis Ulmer <[email protected]>
nishith-fujitsu pushed a commit to nishith-fujitsu/vllm that referenced this pull request Apr 9, 2025
@JenZhao @ywang96 @nishith-fujitsu
[Doc] Update benchmarks README (vllm-project#14646)
efa259b 
Signed-off-by: Jennifer Zhao <[email protected]>
Co-authored-by: Jennifer Zhao <[email protected]>
Co-authored-by: Roger Wang <[email protected]>
@ckhordiasma ckhordiasma mentioned this pull request Apr 17, 2025
Closed
shreyankg pushed a commit to shreyankg/vllm that referenced this pull request May 3, 2025
@JenZhao @ywang96 @shreyankg
[Doc] Update benchmarks README (vllm-project#14646)
e1b657f 
Signed-off-by: Jennifer Zhao <[email protected]>
Co-authored-by: Jennifer Zhao <[email protected]>
Co-authored-by: Roger Wang <[email protected]>
RichardoMrMu pushed a commit to RichardoMrMu/vllm that referenced this pull request May 12, 2025
@JenZhao @ywang96
[Doc] Update benchmarks README (vllm-project#14646)
d030967 
Signed-off-by: Jennifer Zhao <[email protected]>
Co-authored-by: Jennifer Zhao <[email protected]>
Co-authored-by: Roger Wang <[email protected]>
Signed-off-by: Mu Huai <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ywang96 ywang96 ywang96 approved these changes

Assignees
No one assigned
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JenZhao @ywang96 @WoosukKwon