OSS-readiness: docs & config reference sync, dependency slimming#29
Merged
Conversation
- 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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Minimal, non-invasive pass from the OSS-readiness review — docs, reference config, and packaging only; no behavior changes.
Packaging
flaskfrom core deps (unused anywhere) and movesentence-transformersto a newkai-evolve[embeddings]extra — it is lazy-imported and only needed forembedding_backend: "local"(novelty detection / strategy clustering), so a plainpip installno longer pulls PyTorch.pymongostays (it providesbson.ObjectIdused for program ids) with a comment explaining why.scipyexplicitly:strategy_clusters.pyusesscipy.cluster.vq.kmeans2at runtime, and scipy was previously only present transitively via sentence-transformers.scripts/requirements.txt:flask→plotly(what the scripts actually import).Config reference sync
configs/default_config.yamlnow covers the newer config families it was missing:require_hmrd, literature review,steering_brief_path, research director, strategy clustering, parent-selection shaping,evaluator.re_evaluations, and thenoveltysection. All values are the code defaults, so copying the file behaves exactly as before.Docs
asyncio.runinstead of bareawait), a concrete copy-paste first run (circle packing), a note on the no---configfallback defaults, an optional-extras install block, and a new Watching and steering a live run section (per-iterationprogress.jsonlfeed, human steering brief /kai steer, research director).configs/bench_alphaevolve.yaml(same fix inautocorrelation_C1/README.md).examples/noisy_optimization/: added README + a small config demonstratingre_evaluations: 3.experiments/: marked as inherited upstream OpenEvolve benchmark infra; the two scripts with hardcoded/Users/codelion/...paths now requireALGOTUNE_PATH/EVOLVEBENCH_PATHenv vars.Verified
Fresh Python 3.9 venv with the slimmed deps (
pip install -e ".[dev]"— no torch/flask installed): full suite Ran 349 tests — OK (12 skipped);kai/kaievolve-runentry points work; every touched or referenced YAML loads throughkaievolve.config.load_configwith the expected values.