Skip to content

Commit 7de0db7

Browse files
committed
Add Quick Demo section to README
1 parent 24c3126 commit 7de0db7

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,17 @@ This project contains two main components:
7676
| `requirements.txt` | Dependencies required to run the script. |
7777
| `tests/` | Unit and integration tests for all components. |
7878

79+
## Quick Demo
80+
81+
Try the minimal working demo (uses 20 sample QA pairs and simulated evaluation):
82+
83+
```bash
84+
export TINKER_API_KEY=sk-... # Your Tinker API key
85+
./run_demo.sh
86+
```
87+
88+
This will run 1-3 training rounds, automatically adjusting the learning rate and triggering Round 2 when scores fall below threshold (0.75). Perfect for understanding the loop before customizing it.
89+
7990
## Quickstart
8091

8192
1. **Install dependencies:**

0 commit comments

Comments
 (0)