Skip to content

[Docs] Update Tensorizer usage documentation #21190

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

sangstar
Copy link
Collaborator

@sangstar sangstar commented Jul 18, 2025

Updated tensorizer usage patterns documentation

This PR updates the two tensorizer usage information sources on vLLM: the example script, and its dedicated documentation page. It reflects the new usage patterns made by recent tensorizer feature updates, and provides a more detailed guide on using tensorizer with vLLM.

@sangstar sangstar requested a review from hmellor as a code owner July 18, 2025 14:38
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.

🚀

@sangstar sangstar self-assigned this Jul 18, 2025
@sangstar sangstar added the documentation Improvements or additions to documentation label Jul 18, 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 PR provides a much-needed update to the tensorizer documentation, reflecting recent simplifications to its usage within vLLM. The new documentation is clearer and more comprehensive. I've identified one paragraph that could be misleading regarding the configuration of serialization versus deserialization and have suggested a clarification to improve user understanding.

@sangstar sangstar requested a review from hmellor July 18, 2025 17:12
Copy link

mergify bot commented Jul 21, 2025

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

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 Jul 21, 2025
sangstar and others added 5 commits July 21, 2025 13:22
@sangstar sangstar force-pushed the sangstar/tensorizer-docs-updated branch from 96cb1df to c1ba86c Compare July 21, 2025 17:23
@mergify mergify bot removed the needs-rebase label Jul 21, 2025
Signed-off-by: Sanger Steel <[email protected]>
@sangstar
Copy link
Collaborator Author

Anything else needed to get this merged? @simon-mo @hmellor @jeejeelee

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.

I had some review comments that I accidentally left pending

@sangstar
Copy link
Collaborator Author

@hmellor Resolved comments! Thanks for the suggestions.

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.

LGTM, thanks for improving the Tensorizer doc!

(adding force-merge because the PR is docs only)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation force-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants