Skip to content

Conversation

samzong
Copy link
Contributor

@samzong samzong commented Sep 16, 2025

Purpose

Ensure BenchmarkDataset docstrings follow the name (type): description format so griffe stops emitting parsing warnings.

WARNING -  griffe: vllm/benchmarks/datasets.py:107: Failed to get 'name: description' pair from 'sampling. Defaults to DEFAULT_SEED.'
--
  | WARNING -  griffe: vllm/benchmarks/datasets.py:237: Failed to get 'name: description' pair from 'request_id_prefix (str) The prefix of the request ids.'
  | WARNING -  griffe: vllm/benchmarks/datasets.py:213: Failed to get 'name: description' pair from 'request_id_prefix (str) The prefix of request_id.'

Test Plan

Test Result


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.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

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 ask your reviewers to trigger select CI tests on top of fastcheck CI.

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.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

🚀

@mergify mergify bot added the performance Performance-related issues label Sep 16, 2025
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 addresses docstring formatting issues in vllm/benchmarks/datasets.py to ensure compatibility with documentation generation tools like griffe. The changes are well-executed and correctly fix indentation, parameter descriptions, and cross-referencing syntax within the docstrings. These modifications improve the overall quality and readability of the code documentation. The pull request successfully meets its objective, and I found no high or critical issues in the changes.

@samzong samzong changed the title fix docstring param formatting in datasets benchmark [Docs] fix docstring param formatting in datasets benchmark Sep 16, 2025
@samzong samzong force-pushed the fix/docstrings-datasets-benchmark branch 2 times, most recently from 1785adf to 9068d1b Compare September 17, 2025 01:34
@samzong samzong changed the title [Docs] fix docstring param formatting in datasets benchmark [Docs] fix docstring param formatting in vllm/benchmarks/datasets.py Sep 17, 2025
@samzong samzong changed the title [Docs] fix docstring param formatting in vllm/benchmarks/datasets.py [Docs] vllm/benchmarks/datasets.py fix docstring param format. Sep 17, 2025
@mgoin mgoin requested a review from hmellor September 17, 2025 02:14
Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mgoin mgoin enabled auto-merge (squash) September 17, 2025 02:15
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Sep 17, 2025
@windsonsea
Copy link
Contributor

Related to issue #25020

Copy link
Member

@hmellor hmellor 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 the PR, please use Mkdocs format for the cross references (you've used Sphinx), see https://mkdocstrings.github.io/usage/#cross-references

@hmellor hmellor disabled auto-merge September 17, 2025 06:48
Copy link

mergify bot commented Sep 17, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @samzong.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Sep 17, 2025
Signed-off-by: samzong <samzong.lu@gmail.com>
@samzong samzong force-pushed the fix/docstrings-datasets-benchmark branch from 9068d1b to f6d480c Compare September 17, 2025 14:02
@mergify mergify bot removed the needs-rebase label Sep 17, 2025
@simon-mo simon-mo merged commit 4a2d33e into vllm-project:main Sep 17, 2025
37 of 42 checks passed
FeiDaLI pushed a commit to FeiDaLI/vllm that referenced this pull request Sep 25, 2025
charlifu pushed a commit to ROCm/vllm that referenced this pull request Sep 25, 2025
…project#24970)

Signed-off-by: samzong <samzong.lu@gmail.com>
Signed-off-by: charlifu <charlifu@amd.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance Performance-related issues ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants