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

Merge similar examples in offline_inference into single basic example #12737

Merged
merged 18 commits into from
Feb 20, 2025

Conversation

hmellor
Copy link
Collaborator

@hmellor hmellor commented Feb 4, 2025

Motivation:

  • Reduces number of unnecessary examples reducing clutter
  • Basic examples are now fully configurable, making them more useful:
    • for experimentation for new users
    • as debugging tools for developers

Changes:

  • Move basic.py, chat.py, classify.py, embed.py, generate.py, score.py to examples/offline_inference/basic because they were almost identical:
    • Add README to examples/offline_inference/basic walking through all the contained scripts
    • Add ArgumentParser for all EngineArgs to each of these scripts (except basic.py)
    • Add ArgumentParser for some SamplingParams for chat.py and generate.py
  • Deleted examples/offline_inference/cli.py as it's no longer relevant
  • Add signpost to this new example in https://docs.vllm.ai/en/latest/getting_started/examples/examples_offline_inference_index.html
  • Delete and added args to recreate to README for the following examples:
    • examples/offline_inference/aqlm_example.py
    • examples/offline_inference/arctic.py
    • examples/offline_inference/basic_with_model_default_sampling.py
    • examples/offline_inference/cpu_offload.py
    • examples/offline_inference/gguf_inference.py

Copy link

github-actions bot commented Feb 4, 2025

👋 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 bot added the documentation Improvements or additions to documentation label Feb 4, 2025
@mergify mergify bot added the ci/build label Feb 18, 2025
Signed-off-by: Harry Mellor <[email protected]>
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.

LGTM now, thanks for the cleanup

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) February 19, 2025 10:34
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Feb 19, 2025
@hmellor
Copy link
Collaborator Author

hmellor commented Feb 19, 2025

Here's a link to the multi-file example that was created for posterity https://vllm--12737.org.readthedocs.build/en/12737/getting_started/examples/basic.html

auto-merge was automatically disabled February 19, 2025 17:21

Head branch was pushed to by a user without write access

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) February 20, 2025 12:53
@simon-mo simon-mo merged commit 992e5c3 into vllm-project:main Feb 20, 2025
68 of 71 checks passed
@hmellor hmellor deleted the merge-similar-examples branch February 20, 2025 13:17
kerthcet pushed a commit to kerthcet/vllm that referenced this pull request Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/build documentation Improvements or additions to documentation 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.

4 participants