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

[Core] Enable hf_transfer by default if available #3817

Merged
merged 7 commits into from
Apr 4, 2024

Conversation

michaelfeil
Copy link
Contributor

@michaelfeil michaelfeil commented Apr 3, 2024

This is a "quality of life" PR. It auto enables the hf_transfer backend of huggingface_hub. As explained in #2907, hf_transfer should be safe to use, e.g. is the default in TGI since pretty long. https://github.com/huggingface/text-generation-inference/blob/92bb56b0c1038a35f73a6c96c506f6d1c3d7b043/Dockerfile#L151
Enabling it with a env variable misses a fair amount of users + leads to hf_transfer beeing forced to be enabled globally - even if available just in this Python env.

Closes #2907 (fix)
Related #3031 #3008

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!

@michaelfeil michaelfeil marked this pull request as draft April 3, 2024 14:34
@michaelfeil michaelfeil marked this pull request as ready for review April 3, 2024 16:44
@michaelfeil michaelfeil changed the title [Model] hf_transfer - auto usage if available [Core] hf_transfer - auto usage if available Apr 3, 2024
@njhill
Copy link
Member

njhill commented Apr 3, 2024

Thanks @michaelfeil this looks great. I'm wondering though should we check for whether the HF_HUB_ENABLE_HF_TRANSFER env var is set explicitly and only auto-enable if it isn't? To allow users to disable it if they need to when using the docker image for example.

@michaelfeil
Copy link
Contributor Author

Thanks @michaelfeil this looks great. I'm wondering though should we check for whether the HF_HUB_ENABLE_HF_TRANSFER env var is set explicitly and only auto-enable if it isn't? To allow users to disable it if they need to when using the docker image for example.

Will follow up with: if HF_HUB_ENABLE_HF_TRANSFER is set, ignore any logic in vllm.

Copy link
Member

@njhill njhill left a comment

Choose a reason for hiding this comment

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

Thanks @michaelfeil!

@njhill njhill changed the title [Core] hf_transfer - auto usage if available [Core] Enable hf_transfer by default if available Apr 4, 2024
@njhill njhill enabled auto-merge (squash) April 4, 2024 03:42
@njhill njhill merged commit 537ee25 into vllm-project:main Apr 4, 2024
35 checks passed
@michaelfeil michaelfeil deleted the hf-transfer branch April 4, 2024 04:40
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request Apr 22, 2024
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
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.

Feature request: Enable activation of hf_transfer if available.
2 participants