Skip to content

Commit b7efbb4

Browse files
committed
docs: update README for PyPI installation
- Primary install is now `pip install thinkbooster` - setup.sh moved to optional section for advanced scorers - Added PyPI badge - Updated Python version badge to 3.10+ - Removed lm-polygraph submodule from project structure
1 parent 700fda9 commit b7efbb4

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
</div>
55

66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7-
[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
7+
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
8+
[![PyPI](https://img.shields.io/pypi/v/thinkbooster)](https://pypi.org/project/thinkbooster/)
89
[![arXiv](https://img.shields.io/badge/arXiv-b31b1b.svg)](https://thinkbooster.s3.us-east-1.amazonaws.com/thinkbooster.pdf)
910

1011
[Quick Start](#quick-start) | [Key Features](#key-features) | [Strategies](#supported-strategies) | [Visual Debugger](#visual-debugger) | [Documentation](#documentation)
@@ -28,20 +29,33 @@ ThinkBooster is an open-source framework for **test-time compute scaling** of la
2829
### Installation
2930

3031
```bash
31-
# Clone the repository
32+
pip install thinkbooster
33+
```
34+
35+
Or install from source for development:
36+
37+
```bash
3238
git clone https://github.com/IINemo/thinkbooster.git
3339
cd thinkbooster
40+
pip install -e ".[dev]"
41+
```
42+
43+
<details>
44+
<summary>Optional: additional scorers (UHead, KernelAct)</summary>
3445

35-
# Create conda environment
36-
conda create -n thinkbooster python=3.11 -y
37-
conda activate thinkbooster
46+
Some advanced scorers require GitHub-only dependencies. Run `setup.sh` after pip install:
3847

39-
# Install dependencies
48+
```bash
4049
./setup.sh
50+
```
51+
52+
This installs `llm-uncertainty-head`, `vllm-speculators`, and `KernelAct`. Core functionality (all strategies, PRM/entropy/probability scorers, evaluation) works without these.
4153

42-
# Configure API keys
54+
</details>
55+
56+
```bash
57+
# Configure API keys (optional, for LLM judge and OpenRouter)
4358
cp .env.example .env
44-
# Edit .env and add your OPENROUTER_API_KEY
4559
```
4660

4761
### REST API
@@ -151,7 +165,7 @@ thinkbooster/
151165
├── service_app/ # REST API service + visual debugger
152166
├── tests/ # Test suite with strategy registry
153167
├── docs/ # Documentation
154-
└── lm-polygraph/ # Submodule: uncertainty estimation
168+
└── setup.sh # Optional: install GitHub-only deps (UHead, KernelAct)
155169
```
156170

157171
See [Project Structure](docs/getting_started/project_structure.md) for a detailed architecture overview.

0 commit comments

Comments
 (0)