Merge branch 'main' into feature/improved-whitespace-handling

Author: jvm123

.github/workflows/python-lint.yml

@@ -0,0 +1,17 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+          src: "./openevolve ./tests ./examples"
+          use_pyproject: true

.github/workflows/python-test.yml

@@ -0,0 +1,25 @@
+name: Python Unit Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Run unit tests
+      run: |
+        python -m unittest discover -s tests -p "*.py"

Dockerfile

@@ -0,0 +1,22 @@
+# Use an official Python image as the base
+FROM python:3.12-slim
+
+# Set the working directory inside the container
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy the project files into the container
+COPY . /app
+
+# Install Python dependencies
+RUN pip install --root-user-action=ignore -e .
+
+# Expose the project directory as a volume
+VOLUME ["/app"]
+
+# Set the entry point to the openevolve-run.py script
+ENTRYPOINT ["python", "/app/openevolve-run.py"]

Makefile

@@ -0,0 +1,40 @@
+# Variables
+PROJECT_DIR := $(shell pwd)
+DOCKER_IMAGE := openevolve
+VENV_DIR := $(PROJECT_DIR)/env
+PYTHON := $(VENV_DIR)/bin/python
+PIP := $(VENV_DIR)/bin/pip
+
+# Default target
+.PHONY: all
+all: install test
+
+# Create and activate the virtual environment
+.PHONY: venv
+venv:
+	python3 -m venv $(VENV_DIR)
+
+# Install Python dependencies in the virtual environment
+.PHONY: install
+install: venv
+	$(PIP) install -e .
+
+# Run Black code formatting
+.PHONY: lint
+lint: venv
+	$(PYTHON) -m black openevolve examples tests
+
+# Run tests using the virtual environment
+.PHONY: test
+test: venv
+	$(PYTHON) -m unittest discover -s tests -p "test_*.py"
+
+# Build the Docker image
+.PHONY: docker-build
+docker-build:
+	docker build -t $(DOCKER_IMAGE) .
+
+# Run the Docker container with the example
+.PHONY: docker-run
+docker-run:
+	docker run --rm -v $(PROJECT_DIR):/app $(DOCKER_IMAGE) examples/function_minimization/initial_program.py examples/function_minimization/evaluator.py --config examples/function_minimization/config.yaml --iterations 1000

README.md

@@ -27,6 +27,7 @@ OpenEvolve follows an evolutionary approach with the following components:
 
 ### Installation
 
+To install natively, use:
 ```bash
 git clone https://github.com/codelion/openevolve.git
 cd openevolve
@@ -60,6 +61,44 @@ OpenEvolve can also be run from the command line:
 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.)
+
+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
+```
+### Docker
+
+You can also install and execute via Docker:
+```bash
+docker build -t openevolve .
+docker run --rm -v .:/app 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: