Skip to content

[Doc] Fix the lora adapter path in server startup script #6230

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

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

Jeffwan
Copy link
Contributor

@Jeffwan Jeffwan commented Jul 8, 2024

Check the issue for more details. Current lora model path doesn't work and throws error in runtime

FIX #6229

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!

@DarkLight1337 DarkLight1337 requested a review from Yard1 July 9, 2024 01:59
@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 9, 2024

@Yard1 Please help check this issue for a short term doc fix

@Yard1
Copy link
Collaborator

Yard1 commented Jul 9, 2024

The snapshot path may change... not sure what's the best way to solve that here.

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 9, 2024

@Yard1 Yeah, I think the idea here is to give user an idea they should append the full path instead of giving them 100% correct path. This is from some of our users without too many experiences to debug the issue.

Copy link
Collaborator

@Yard1 Yard1 left a comment

Choose a reason for hiding this comment

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

Can we add a note the path may change

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 9, 2024

Can we add a note the path may change

That's a good suggestion. I updated the code and left a comment there. Please take another look

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 12, 2024

@Yard1 I am new to vLLM community. What's the review and merge process? Once the PR is reviewed, will any approver merge the PR?

@DarkLight1337
Copy link
Member

Usually, the approver is the one to merge the PR. Hope that @Yard1 is free to take another look at this soon.

@Yard1 Yard1 merged commit 94162be into vllm-project:main Jul 16, 2024
70 checks passed
@Yard1
Copy link
Collaborator

Yard1 commented Jul 16, 2024

Thanks!

@Jeffwan Jeffwan deleted the jiaxin/doc-lora-path-change branch July 16, 2024 17:51
fialhocoelho pushed a commit to opendatahub-io/vllm that referenced this pull request Jul 19, 2024
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jul 24, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
LeiWang1999 pushed a commit to LeiWang1999/vllm-bitblas that referenced this pull request Mar 26, 2025
…t#6230)

Signed-off-by: LeiWang1999 <leiwang1999@outlook.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.

[Doc]: Failed to download lora adapter using the path from documentation
3 participants