Skip to content

docs: simplify extras install examples #379

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.

Sign up for GitHub

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
ronakice merged 2 commits into from
Apr 3, 2026
Merged

docs: simplify extras install examples #379

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
038e2cf
docs: simplify extras install examples
ronakice Apr 3, 2026
5a6483d
docs: tighten extras README wording
ronakice Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 9 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,24 +75,11 @@ If you prefer not to activate the virtual environment, run commands through
Install only the stacks you need:

```bash
uv sync --group dev --extra openai
uv sync --group dev --extra genai
uv sync --group dev --extra cloud
uv sync --group dev --extra local
uv sync --group dev --extra pyserini
uv sync --group dev --extra api
uv sync --group dev --extra mcp
uv sync --group dev --extra vllm
uv sync --group dev --extra sglang
uv sync --group dev --extra tensorrt-llm
uv sync --group dev --extra server
uv sync --group dev --extra training
uv sync --group dev --extra all
```

`genai` is the canonical Google Gemini extra. `gemini` remains available as a
compatibility alias. `cloud` installs both the OpenAI-compatible and Gemini
hosted-provider stacks.
uv sync --group dev --extra <extra>
```

Replace `<extra>` with one of the extras in the feature matrix below. You can
repeat `--extra` to combine stacks in one environment.

### Feature Matrix

Expand Down Expand Up @@ -135,16 +122,12 @@ pip install -e .
Then install the optional stack you need, for example:

```bash
pip install -e ".[openai]"
pip install -e ".[genai]"
pip install -e ".[cloud]"
pip install -e ".[local]"
pip install -e ".[pyserini]"
pip install -e ".[api]"
pip install -e ".[mcp]"
pip install -e ".[vllm]"
pip install -e ".[<extra>]"
```

Replace `<extra>` with one of the extras in the feature matrix below. You can
combine extras as needed, for example `pip install -e ".[openai,api]"`.

Remember to install `flashinfer` for the `sglang` backend and `flash-attn` for
optimized TensorRT-LLM or training workflows when those stacks require them.

Expand Down
Loading