openevolve 0.0.1__tar.gz

openevolve-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openevolve-0.0.1/PKG-INFO

@@ -0,0 +1,325 @@
+Metadata-Version: 2.4
+Name: openevolve
+Version: 0.0.1
+Summary: Open-source implementation of AlphaEvolve
+Author: codelion
+License: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: numpy>=1.22.0
+Requires-Dist: tqdm>=4.64.0
+Requires-Dist: flask
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: mypy>=0.950; extra == "dev"
+Dynamic: license-file
+
+# OpenEvolve
+
+An open-source implementation of the AlphaEvolve system described in the Google DeepMind paper "AlphaEvolve: A coding agent for scientific and algorithmic discovery" (2025).
+
+![OpenEvolve Logo](openevolve-logo.png)
+
+## Overview
+
+OpenEvolve is an evolutionary coding agent that uses Large Language Models to optimize code through an iterative process. It orchestrates a pipeline of LLM-based code generation, evaluation, and selection to continuously improve programs for a variety of tasks.
+
+Key features:
+- Evolution of entire code files, not just single functions
+- Support for multiple programming languages
+- Supports OpenAI-compatible APIs for any LLM
+- Multi-objective optimization
+- Flexible prompt engineering
+- Distributed evaluation
+
+## How It Works
+
+OpenEvolve follows an evolutionary approach with the following components:
+
+![OpenEvolve Architecture](openevolve-architecture.png)
+
+1. **Prompt Sampler**: Creates context-rich prompts containing past programs, their scores, and problem descriptions
+2. **LLM Ensemble**: Generates code modifications via an ensemble of language models
+3. **Evaluator Pool**: Tests generated programs and assigns scores
+4. **Program Database**: Stores programs and their evaluation metrics, guiding future evolution
+
+The controller orchestrates interactions between these components in an asynchronous pipeline, maximizing throughput to evaluate as many candidate solutions as possible.
+
+## Getting Started
+
+### Installation
+
+To install natively, use:
+```bash
+git clone https://github.com/codelion/openevolve.git
+cd openevolve
+pip install -e .
+```
+
+### Quick Start
+
+We use the OpenAI SDK, so you can use any LLM or provider that supports an OpenAI compatible API. Just set the `OPENAI_API_KEY` environment variable
+and update the `api_base` in config.yaml if you are using a provider other than OpenAI. For local models, you can use
+an inference server like [optillm](https://github.com/codelion/optillm).
+
+```python
+from openevolve import OpenEvolve
+
+# Initialize the system
+evolve = OpenEvolve(
+    initial_program_path="path/to/initial_program.py",
+    evaluation_file="path/to/evaluator.py",
+    config_path="path/to/config.yaml"
+)
+
+# Run the evolution
+best_program = await evolve.run(iterations=1000)
+print(f"Best program metrics:")
+for name, value in best_program.metrics.items():
+    print(f"  {name}: {value:.4f}")
+```
+
+### Command-Line Usage
+
+OpenEvolve can also be run from the command line:
+
+```bash
+python openevolve-run.py path/to/initial_program.py path/to/evaluator.py --config path/to/config.yaml --iterations 1000
+```
+
+### Resuming from Checkpoints
+
+OpenEvolve 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:
+
+```bash
+python openevolve-run.py path/to/initial_program.py path/to/evaluator.py \
+  --config path/to/config.yaml \
+  --checkpoint path/to/checkpoint_directory \
+  --iterations 50
+```
+
+When resuming from a checkpoint:
+- The system loads all previously evolved programs and their metrics
+- Checkpoint numbering continues from where it left off (e.g., if loaded from checkpoint_50, the next checkpoint will be checkpoint_60)
+- All evolution state is preserved (best programs, feature maps, archives, etc.)
+- Each checkpoint directory contains a copy of the best program at that point in time
+
+Example workflow with checkpoints:
+
+```bash
+# Run for 50 iterations (creates checkpoints at iterations 10, 20, 30, 40, 50)
+python openevolve-run.py examples/function_minimization/initial_program.py \
+  examples/function_minimization/evaluator.py \
+  --iterations 50
+
+# Resume from checkpoint 50 for another 50 iterations (creates checkpoints at 60, 70, 80, 90, 100)
+python openevolve-run.py examples/function_minimization/initial_program.py \
+  examples/function_minimization/evaluator.py \
+  --checkpoint examples/function_minimization/openevolve_output/checkpoints/checkpoint_50 \
+  --iterations 50
+```
+
+### Comparing Results Across Checkpoints
+
+Each checkpoint directory contains the best program found up to that point, making it easy to compare solutions over time:
+
+```
+checkpoints/
+  checkpoint_10/
+    best_program.py         # Best program at iteration 10
+    best_program_info.json  # Metrics and details
+    programs/               # All programs evaluated so far
+    metadata.json           # Database state
+  checkpoint_20/
+    best_program.py         # Best program at iteration 20
+    ...
+```
+
+You can compare the evolution of solutions by examining the best programs at different checkpoints:
+
+```bash
+# Compare best programs at different checkpoints
+diff -u checkpoints/checkpoint_10/best_program.py checkpoints/checkpoint_20/best_program.py
+
+# Compare metrics
+cat checkpoints/checkpoint_*/best_program_info.json | grep -A 10 metrics
+```
+
+### Visualizing the evolution tree
+
+The script in `scripts/visualize.py` allows you to visualize the evolution tree and display it in your webbrowser. The script watches live for the newest checkpoint directory in the examples/ folder structure and updates the graph. Alternatively, you can also provide a specific checkpoint folder with the `--path` parameter.
+
+```bash
+# Install requirements
+pip install -r scripts/requirements.txt
+
+# Start the visualization web server and have it watch the examples/ folder
+python scripts/visualizer.py
+
+# Start the visualization web server with a specific checkpoint
+python scripts/visualizer.py --path examples/function_minimization/openevolve_output/checkpoints/checkpoint_100/
+```
+
+In the visualization UI, you can
+- see the branching of your program evolution in a network visualization, with node radius chosen by the program fitness (= the currently selected metric),
+- see the parent-child relationship of nodes and click through them in the sidebar (use the yellow locator icon in the sidebar to center the node in the graph),
+- select the metric of interest (with the available metric choices depending on your data set),
+- highlight nodes, for example the top score (for the chosen metric) or the MAP-elites members,
+- click nodes to see their code and prompts (if available from the checkpoint data) in a sidebar,
+- in the "Performance" tab, see their selected metric score vs generation in a graph
+
+![OpenEvolve Visualizer](openevolve-visualizer.png)
+
+### Docker
+
+You can also install and execute via Docker:
+```bash
+docker build -t openevolve .
+docker run --rm -v $(pwd):/app --network="host" openevolve examples/function_minimization/initial_program.py examples/function_minimization/evaluator.py --config examples/function_minimization/config.yaml --iterations 1000
+```
+
+## Configuration
+
+OpenEvolve is highly configurable. You can specify configuration options in a YAML file:
+
+```yaml
+# Example configuration
+max_iterations: 1000
+llm:
+  primary_model: "gemini-2.0-flash-lite"
+  secondary_model: "gemini-2.0-flash"
+  temperature: 0.7
+database:
+  population_size: 500
+  num_islands: 5
+```
+
+Sample configuration files are available in the `configs/` directory:
+- `default_config.yaml`: Comprehensive configuration with all available options
+
+See the [Configuration Guide](configs/default_config.yaml) for a full list of options.
+
+## Artifacts Channel
+
+OpenEvolve includes a **artifacts side-channel** that allows evaluators to capture build errors, profiling results, etc. to provide better feedback to the LLM in subsequent generations. This feature enhances the evolution process by giving the LLM context about what went wrong and how to fix it.
+
+The artifacts channel operates alongside the traditional fitness metrics.
+
+### Example: Compilation Failure Feedback
+
+```python
+from openevolve.evaluation_result import EvaluationResult
+
+return EvaluationResult(
+    metrics={"compile_ok": 0.0, "score": 0.0},
+    artifacts={
+        "stderr": "SyntaxError: invalid syntax (line 15)",
+        "traceback": "...",
+        "failure_stage": "compilation"
+    }
+)
+```
+
+The next generation prompt will include:
+```
+## Last Execution Output
+### Stderr
+```
+SyntaxError: invalid syntax (line 15)
+```
+### Traceback
+```
+...
+```
+```
+
+### Configuration
+
+Artifacts can be controlled via configuration and environment variables:
+
+```yaml
+# config.yaml
+evaluator:
+  enable_artifacts: true
+
+prompt:
+  include_artifacts: true
+  max_artifact_bytes: 4096  # 4KB limit in prompts
+  artifact_security_filter: true
+```
+
+```bash
+# Environment variable to disable artifacts
+export ENABLE_ARTIFACTS=false
+```
+
+### Benefits
+
+- **Faster convergence** - LLMs can see what went wrong and fix it directly
+- **Better error handling** - Compilation and runtime failures become learning opportunities  
+- **Rich debugging context** - Full stack traces and error messages guide improvements
+- **Zero overhead** - When disabled, no performance impact on evaluation
+
+## Examples
+
+See the `examples/` directory for complete examples of using OpenEvolve on various problems:
+
+### Symbolic Regression
+
+A comprehensive example demonstrating OpenEvolve's application to symbolic regression tasks using the LLM-SRBench benchmark. This example shows how OpenEvolve can evolve simple mathematical expressions (like linear models) into complex symbolic formulas that accurately fit scientific datasets.
+
+[Explore the Symbolic Regression Example](examples/symbolic_regression/)
+
+Key features:
+- Automatic generation of initial programs from benchmark tasks
+- Evolution from simple linear models to complex mathematical expressions
+- Evaluation on physics, chemistry, biology, and material science datasets
+- Competitive results compared to state-of-the-art symbolic regression methods
+
+### Circle Packing
+
+Our implementation of the circle packing problem from the AlphaEvolve paper. For the n=26 case, where one needs to pack 26 circles in a unit square we also obtain SOTA results.
+
+[Explore the Circle Packing Example](examples/circle_packing/)
+
+We have sucessfully replicated the results from the AlphaEvolve paper, below is the packing found by OpenEvolve after 800 iterations
+
+![alpha-evolve-replication](https://github.com/user-attachments/assets/00100f9e-2ac3-445b-9266-0398b7174193)
+
+This is exactly the packing reported by AlphaEvolve in their paper (Figure 14):
+
+![alpha-evolve-results](https://github.com/user-attachments/assets/0c9affa5-053d-404e-bb2d-11479ab248c9)
+
+### Function Minimization
+
+An example showing how OpenEvolve can transform a simple random search algorithm into a sophisticated simulated annealing approach.
+
+[Explore the Function Minimization Example](examples/function_minimization/)
+
+## Preparing Your Own Problems
+
+To use OpenEvolve for your own problems:
+
+1. **Mark code sections** to evolve with `# EVOLVE-BLOCK-START` and `# EVOLVE-BLOCK-END` comments
+2. **Create an evaluation function** that returns a dictionary of metrics
+3. **Configure OpenEvolve** with appropriate parameters
+4. **Run the evolution** process
+
+## Citation
+
+If you use OpenEvolve in your research, please cite:
+
+```
+@software{openevolve,
+  title = {OpenEvolve: Open-source implementation of AlphaEvolve},
+  author = {Asankhaya Sharma},
+  year = {2025},
+  publisher = {GitHub},
+  url = {https://github.com/codelion/openevolve}
+}
+```