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

[Doc]: Update tensorizer docs to include vllm[tensorizer] #7889

Merged
merged 5 commits into from
Oct 22, 2024

Conversation

sethkimmel3
Copy link
Contributor

It doesn't note in the documentation that you must install the tensorizer extension to the vllm package to run the example. I'm suggesting that addition.

FIX #6791

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.

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!

It doesn't note in the documentation that you must install the `tensorizer` extension to the vllm package to run the example. I'm suggesting that addition.
Copy link

👋 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 consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge).

To run full CI, you can do one of these:

  • Comment /ready on the PR
  • Add ready label to the PR
  • Enable auto-merge.

🚀

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
@simon-mo
Copy link
Collaborator

simon-mo commented Oct 9, 2024

Sorry about that late review, it looks like the doc build failed

@sethkimmel3
Copy link
Contributor Author

The error it's giving is No module named 'vllm.commit_id'. Since it's a simple content change in one of the pages, it seems maybe the doc test had an anomalous failure? @simon-mo or @KaunilD are you able to just re-run that test?

@sethkimmel3
Copy link
Contributor Author

Now error is: No module named 'vllm._version'


.. note::
Note that to use this feature you will need to install `tensorizer` by running `pip install vllm[tensorizer]`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think an indent is needed


[2024-10-09T16:26:18Z] Warning, treated as error:
--
  | [2024-10-09T16:26:18Z] /vllm-workspace/test_docs/docs/source/serving/tensorizer.rst:14:Content block expected for the "note" directive; none found.
  | [2024-10-09T16:26:19Z] make: *** [Makefile:20: html] Error 2


@sethkimmel3
Copy link
Contributor Author

Fixed @simon-mo

@simon-mo simon-mo merged commit 208cb34 into vllm-project:main Oct 22, 2024
29 checks passed
charlifu pushed a commit to charlifu/vllm that referenced this pull request Oct 23, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: charlifu <charlifu@amd.com>
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: Alvant <alvasian@yandex.ru>
MErkinSag pushed a commit to MErkinSag/vllm that referenced this pull request Oct 26, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: Erkin Sagiroglu <erkin@infra-aipipeline-1-at1-prox-prod-a.ipa.corp.telnyx.com>
garg-amit pushed a commit to garg-amit/vllm that referenced this pull request Oct 28, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: Amit Garg <mitgarg17495@gmail.com>
FerdinandZhong pushed a commit to FerdinandZhong/vllm that referenced this pull request Oct 29, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: qishuai <ferdinandzhong@gmail.com>
NickLucche pushed a commit to NickLucche/vllm that referenced this pull request Oct 31, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: NickLucche <nlucches@redhat.com>
NickLucche pushed a commit to NickLucche/vllm that referenced this pull request Oct 31, 2024
…ct#7889)

Co-authored-by: Kaunil Dhruv <dhruv.kaunil@gmail.com>
Signed-off-by: NickLucche <nlucches@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: tensorizer error: name '_write_stream' is not defined
3 participants