Skip to content

[Doc] update README #36

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
torchspec-bot merged 1 commit into from
Mar 7, 2026
Merged

[Doc] update README #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ TorchSpec supports two inference backends:

| Backend | Best For | Installation |
|---------|----------|--------------|
| **SGLang** | Production workloads, high throughput | `./tools/build_conda.sh 1 sglang` (default) |
| **vLLM** | Flexibility, easier deployment | `./tools/build_conda.sh 1 vllm` |
| **SGLang** | Production workloads, high throughput | `./tools/build_conda.sh 1 sglang` |
| **Both** | Development, comparison testing | `./tools/build_conda.sh 1 both` |

### Quick Setup

```bash
# Install with SGLang (default)
./tools/build_conda.sh
# Install with vLLM
./tools/build_conda.sh 1 vllm
micromamba activate torchspec

# Or install with vLLM
./tools/build_conda.sh 1 vllm
# Or install with SGLang
./tools/build_conda.sh
micromamba activate torchspec
```

Expand All @@ -43,14 +43,14 @@ pip install -e ".[fa]"

### Backend-Specific Usage

**SGLang (default):**
**vLLM:**
```bash
./examples/qwen3-8b-single-node/run.sh
./examples/qwen3-8b-single-node/run.sh --config configs/vllm_qwen3_8b.yaml
```

**vLLM:**
**SGLang:**
```bash
./examples/qwen3-8b-single-node/run.sh --config configs/vllm_qwen3_8b.yaml
./examples/qwen3-8b-single-node/run.sh
```

TorchSpec uses vLLM's **Worker Extension** mechanism to hook into the model's forward pass and capture hidden states directly in the worker processes. This avoids RPC serialization issues and enables reliable hidden states extraction.
Expand Down