Skip to content
Open
Changes from all commits
Commits
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
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,46 +70,46 @@ features!

## Installation

- You can install Tunix in several ways:
You can install Tunix in several ways:

1. From PyPI (recommended):

```sh
pip install "google-tunix[prod]"
```
```sh
pip install "google-tunix[prod]"
```

2. Directly from GitHub (latest main branch)

```sh
pip install git+https://github.com/google/tunix
```
```sh
pip install git+https://github.com/google/tunix
```

3. From source (editable install) If you plan to modify the codebase and run it
in development mode. If you'd like to install vllm, the tpu-inference
supported version is not released yet, please follow the instructions to
install manually
(https://docs.vllm.ai/projects/tpu/en/latest/getting_started/installation/)
or download the docker image (vllm/vllm-tpu:v0.11.1) then
`pip install tpu-inference` for TPU backend:

```sh
git clone https://github.com/google/tunix.git
cd tunix
pip install -e ".[dev]"

# Then install vLLM and tpu-inference
```
in development mode. If you'd like to install vllm, the tpu-inference
supported version is not released yet, please follow the instructions to
install manually
(https://docs.vllm.ai/projects/tpu/en/latest/getting_started/installation/)
or download the docker image (vllm/vllm-tpu:v0.11.1) then
`pip install tpu-inference` for TPU backend:

```sh
git clone https://github.com/google/tunix.git
cd tunix
pip install -e ".[dev]"

- Using tunix with SGLang-Jax rollout
# Then install vLLM and tpu-inference
```

Using tunix with SGLang-Jax rollout

1. Install tunix using above ways
1. Then install SGLang-Jax

```
git clone git@github.com:sgl-project/sglang-jax.git
cd sglang-jax/python
pip install -e .
```
```
git clone git@github.com:sgl-project/sglang-jax.git
cd sglang-jax/python
pip install -e .
```

## Getting Started

Expand Down