Skip to content

Conversation

@wangchen615
Copy link
Contributor

@wangchen615 wangchen615 commented Nov 5, 2025

Purpose

Clarify LoRA resolver plugin behavior and configuration in vllm/plugins/lora_resolvers/README.md:

  • All listed resolver plugins are enabled; at request time, vLLM tries them in order until one succeeds.
  • Storage backends must be mounted and provided to the resolver as a storage path.
  • Improve intro phrasing for brevity and consistency.

Test Plan

  • View the updated README in GitHub’s preview to verify formatting, code fences, and bullet rendering.
  • Sanity-check links and environment variable names against vllm/envs.py.
  • Confirm no runtime or API impact (docs-only).

Test Result

  • README renders correctly in GitHub preview (bullets/code blocks look correct).
  • Env var names verified against vllm/envs.py.
  • No code or API changes introduced.

cc @joerunde @angkywilliam @jberkhahn @kfswain @simon-mo

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

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 significantly improves the documentation for LoRA resolver plugins by providing a comprehensive README.md. The new documentation is well-structured and covers setup, usage, advanced configuration, and troubleshooting. I've identified a couple of areas where the wording could be clarified to prevent user confusion, particularly regarding storage backends and the example of a custom S3 resolver. Overall, this is a valuable documentation update.

@wangchen615 wangchen615 force-pushed the docs/lora-resolvers-readme-update-20251105140751 branch 3 times, most recently from b23a3dc to a88875f Compare November 5, 2025 20:17
…ng requirement\n\n- Incorporate two reviewer-suggested sentence updates\n- Keep wording consistent across README\n\nCo-authored-by: Gemini Review Bot <noreply@example.com>

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
@wangchen615 wangchen615 force-pushed the docs/lora-resolvers-readme-update-20251105140751 branch from a88875f to 37ef3a9 Compare November 5, 2025 20:44
Copy link

@kfswain kfswain 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!

wangchen615 and others added 2 commits November 14, 2025 10:04
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@mergify
Copy link

mergify bot commented Nov 14, 2025

Documentation preview: https://vllm--28153.org.readthedocs.build/en/28153/

@mergify mergify bot added the documentation Improvements or additions to documentation label Nov 14, 2025
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor hmellor enabled auto-merge (squash) November 14, 2025 15:47
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Nov 14, 2025
@hmellor hmellor merged commit 9261eb3 into vllm-project:main Nov 14, 2025
44 checks passed
geodavic pushed a commit to geodavic/vllm that referenced this pull request Nov 16, 2025
…equirement (vllm-project#28153)

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: George D. Torres <gdavtor@gmail.com>
bwasti pushed a commit to bwasti/vllm that referenced this pull request Nov 17, 2025
…equirement (vllm-project#28153)

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Bram Wasti <bwasti@meta.com>
devpatelio pushed a commit to SumanthRH/vllm that referenced this pull request Nov 29, 2025
…equirement (vllm-project#28153)

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
kitaekatt pushed a commit to kitaekatt/vllm that referenced this pull request Dec 1, 2025
…equirement (vllm-project#28153)

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
charlotte12l pushed a commit to charlotte12l/vllm that referenced this pull request Dec 5, 2025
…equirement (vllm-project#28153)

Signed-off-by: Chen Wang <Chen.Wang1@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Xingyu Liu <charlotteliu12x@gmail.com>
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 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.

3 participants