You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit e01a328
Browse filesBrowse the repository at this point in the historyBrowse files
* chore: OSS-readiness pass (docs, config reference, deps)
- pyproject: drop unused flask; move sentence-transformers to an
[embeddings] extra (lazy-imported, only needed for local embedding
backends); keep pymongo with a note (provides bson.ObjectId)
- default_config.yaml: sync with config.py — add require_hmrd,
literature review, steering brief, research director, strategy
clustering, parent-selection shaping, re_evaluations, novelty
- README: runnable quick-start snippet (asyncio.run), concrete
first-run command, no-config defaults note, optional extras, new
'watching and steering a live run' section; point alphaevolve
examples at configs/bench_alphaevolve.yaml
- examples: README + config for noisy_optimization (re_evaluations);
fix autocorrelation_C1 references to a non-existent config.yaml
- experiments: mark as inherited upstream benchmarks; require
ALGOTUNE_PATH/EVOLVEBENCH_PATH env vars (drop personal defaults)
- CONTRIBUTING fork URL, scripts/requirements.txt (flask -> plotly),
NOTICE year
* fix: add scipy to core deps (strategy clustering kmeans2)
scipy was only present transitively via sentence-transformers; moving
that to the [embeddings] extra dropped it, breaking
strategy_clusters._cluster and its tests. Declare it explicitly.
Copy file name to clipboardExpand all lines: README.md
+53-3Lines changed: 53 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,14 @@ cd kai-evolve
98
98
pip install -e .
99
99
```
100
100
101
+
Optional extras:
102
+
```bash
103
+
pip install -e ".[viewer]"# the `kai viewer` web UI (FastAPI + Jinja)
104
+
pip install -e ".[embeddings]"# local embedding models for novelty detection /
105
+
# strategy clustering (pulls in PyTorch; the
106
+
# default "api" embedding backend needs no extra)
107
+
```
108
+
101
109
### Quick Start
102
110
103
111
#### Setting up LLM Access
@@ -128,7 +136,9 @@ KaiEvolve uses the OpenAI SDK, which means it works with any LLM provider that s
128
136
This setup ensures KaiEvolve can work with any LLM provider - OpenAI, Anthropic, Google, Cohere, local models via Ollama/vLLM, or any OpenAI-compatible endpoint.
> `https://openrouter.ai/api/v1`). Those model names only resolve if your
184
+
> endpoint actually serves them, so passing an explicit config is recommended.
185
+
160
186
### Resuming from Checkpoints
161
187
162
188
KaiEvolve automatically saves checkpoints at intervals specified by the `checkpoint_interval` config parameter (default is 10 iterations). You can resume an evolution run from a saved checkpoint:
@@ -279,6 +305,30 @@ the solution view. See [`skills/visualization/SKILL.md`](skills/visualization/SK
279
305
and the two reference visualizers under `examples/alphaevolve/` (circle packing and
280
306
the autocorrelation step function).
281
307
308
+
### Watching and steering a live run
309
+
310
+
Active runs append a per-iteration `progress.jsonl` feed to their output
311
+
directory; `kai monitor` and the web viewer read it, so both update in real
312
+
time while a run is going (and keep working on finished runs).
313
+
314
+
Two steering channels can redirect a run **while it is running**:
315
+
316
+
- **Human steering brief** — point `prompt.steering_brief_path` at a markdown
317
+
file and edit it mid-run: its contents are re-read every iteration and
318
+
injected into generation prompts, so directives like "focus on the inner
319
+
loop" or "avoid approach X" take effect without restarting or touching
320
+
config. `kai steer` sets, appends to, or shows that file from the terminal.
321
+
- **Research director** (opt-in) — an automated meta-agent that periodically
322
+
reads the population and writes a strategic directive into the same steering
323
+
channel. Enable it with `prompt.research_director_enabled: true`; optionally
324
+
set `research_director_interval` (defaults to the migration interval) and
325
+
`research_director_model`for a dedicated reasoning model (defaults to the
Five open mathematical problems from the AlphaEvolve paper (autocorrelation_C1, packing_circles_max_sum_of_radii, no_isosceles_triangles, happy_ending, unit_distances), each packaged as an initial program plus evaluator plus config ready to evolve.
553
+
Five open mathematical problems from the AlphaEvolve paper (autocorrelation_C1, packing_circles_max_sum_of_radii, no_isosceles_triangles, happy_ending, unit_distances), each packaged as an initial program plus evaluator. Run them with the suite config tuned for these tasks, [`configs/bench_alphaevolve.yaml`](configs/bench_alphaevolve.yaml).
0 commit comments