From 7f7f989e0e5c0e00c2eabf4c96e1686fe8297e2a Mon Sep 17 00:00:00 2001 From: Yizheng Huang Date: Tue, 15 Sep 2026 16:00:58 -0700 Subject: [PATCH] docs: make source installation reliable --- README.md | 1 + proeval/README.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fea65e..5de73e0 100644 --- a/README.md +++ b/README.md @@ -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 . ``` diff --git a/proeval/README.md b/proeval/README.md index 0a15c11..9c44c15 100644 --- a/proeval/README.md +++ b/proeval/README.md @@ -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 @@ -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