Skip to content

docs: make source installation reliable #13

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
huangyz0918 merged 1 commit into from
Sep 16, 2026
Merged

docs: make source installation reliable #13

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ research artifacts under `data/`:
```bash
git clone https://github.com/google-deepmind/proeval.git
cd proeval
python -m pip install --upgrade pip
python -m pip install -e .
```

Expand Down
3 changes: 2 additions & 1 deletion proeval/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ need:
```bash
git clone https://github.com/google-deepmind/proeval.git
cd proeval
python -m pip install --upgrade pip
python -m pip install -e .
python -m pip install -e ".[encoder]" # BQEncoderSampler and encoder training
python -m pip install -e ".[topics]" # TopicAwareGenerator
Expand Down Expand Up @@ -735,7 +736,7 @@ python -m experiment.exp_performance_estimation \

| Variable | Description |
| -------------------- | ------------------------------------------------------------------------- |
| `OPENROUTER_API_KEY` | Required for `LLMPredictor`, `TopicAwareGenerator`, and embedding metrics |
| `OPENROUTER_API_KEY` | Default credential for OpenRouter-backed evaluation, generation, and metrics; not needed when `LLMPredictor` receives a custom client |

## Available Data Files

Expand Down