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

Update "Contribute" guide with uv and DevContainer intructions #1405

Merged
merged 4 commits into from
Feb 14, 2025

Conversation

yvan-sraka
Copy link
Contributor

@yvan-sraka yvan-sraka commented Feb 6, 2025

Rendered

  • Add instructions about different outlines "flavors"

@yvan-sraka yvan-sraka self-assigned this Feb 6, 2025
@yvan-sraka
Copy link
Contributor Author

yvan-sraka commented Feb 6, 2025

@cpfiffer I'm not sure what's the best guide to update, but it could be nice to also add something like:

Optional Dependencies

Outlines provides multiple optional dependency sets to support different backends and use cases. You can install them as needed using:

  • pip install ".[vllm]" for vLLM, optimized for high-throughput inference.
  • pip install ".[transformers]" for Hugging Face Transformers.
  • pip install ".[mlxlm]" for MLX-LM, optimized for Apple silicon.
  • pip install ".[openai]" to use OpenAI’s API.
  • pip install ".[llamacpp]" for llama.cpp, a lightweight LLM inference engine.
  • pip install ".[exllamav2]" for ExLlamaV2, optimized for NVIDIA GPUs.

WDYT?

@cpfiffer
Copy link
Contributor

cpfiffer commented Feb 6, 2025

I would stick the extra deps stuff in the installation guide but use pip install "outlines[vllm]" instead. Let's also stick an example that uses the dot-install method for one of the backends in the contribution guide, but point to available installation backends in the installaction guide.

@yvan-sraka
Copy link
Contributor Author

I would stick the extra deps stuff in the installation guide but use pip install "outlines[vllm]" instead. Let's also stick an example that uses the dot-install method for one of the backends in the contribution guide, but point to available installation backends in the installaction guide.

@cpfiffer I'm not 100% sure if I can drop the first paragraph here then, that sounds a bit redundant, right?

@yvan-sraka yvan-sraka requested a review from cpfiffer February 7, 2025 12:45
@cpfiffer
Copy link
Contributor

cpfiffer commented Feb 7, 2025

I'm not sure what it's redundant with. As far as I am aware, the paragraph you suggested is the only comprehensive list of supportive optional dependency commands.

Optional Dependencies

Outlines provides multiple optional dependency sets to support different backends and use cases. You can install them as needed using:

  • pip install ".[vllm]" for vLLM, optimized for high-throughput inference.
  • pip install ".[transformers]" for Hugging Face Transformers.
  • pip install ".[mlxlm]" for MLX-LM, optimized for Apple silicon.
  • pip install ".[openai]" to use OpenAI’s API.
  • pip install ".[llamacpp]" for llama.cpp, a lightweight LLM inference engine.
  • pip install ".[exllamav2]" for ExLlamaV2, optimized for NVIDIA GPUs.

Then, in the contribution guide, we would only need to refer to this list and highlight the single most common optional dependency to indicate what the users should expect to find in the installation guide.

@yvan-sraka yvan-sraka marked this pull request as ready for review February 10, 2025 10:11
@rlouf
Copy link
Member

rlouf commented Feb 14, 2025

@yvan-sraka is it ready to merge?

@yvan-sraka yvan-sraka merged commit ad7a740 into main Feb 14, 2025
7 checks passed
@yvan-sraka yvan-sraka deleted the update-contribute-guide branch February 14, 2025 13:31
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.

3 participants