weco 0.2.6__tar.gz → 0.2.8__tar.gz

{weco-0.2.6 → weco-0.2.8}/.github/workflows/lint.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - dev
+  pull_request:  # Run on any pull request
 
 jobs:
   lint:
@@ -12,9 +13,7 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
-      with:
-        ref: ${{ github.head_ref }}
+      uses: actions/checkout@v4
 
     - name: Set up Python
       uses: actions/setup-python@v3
@@ -26,15 +25,19 @@ jobs:
         python -m pip install --upgrade pip
         pip install ruff
 
-    - name: Run linter
+    - name: Run Linter (PR Check)
+      if: github.event_name == 'pull_request'
       run: |
-        ruff check . --fix
-      
-    - name: Run formatter
+        ruff check .
+
+    - name: Run Linter & Formatter (Push)
+      if: github.event_name == 'push'
       run: |
+        ruff check . --fix
         ruff format .
 
     - name: Commit changes
+      if: github.event_name == 'push'
       run: |
         git config --local user.email "action@github.com"
         git config --local user.name "GitHub Action"

{weco-0.2.6 → weco-0.2.8}/.github/workflows/release.yml

@@ -90,7 +90,7 @@ jobs:
         GITHUB_TOKEN: ${{ github.token }}
       run: >-
         gh release create
-        'v0.2.6'
+        'v0.2.8'
         --repo '${{ github.repository }}'
         --notes ""
 
@@ -102,5 +102,5 @@ jobs:
       # sigstore-produced signatures and certificates.
       run: >-
         gh release upload
-        'v0.2.6' dist/**
+        'v0.2.8' dist/**
         --repo '${{ github.repository }}'

{weco-0.2.6 → weco-0.2.8}/.gitignore

@@ -69,3 +69,5 @@ etc/
 # AI generated files
 digest.txt
 .runs/
+
+*.pyc

{weco-0.2.6 → weco-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: weco
-Version: 0.2.6
+Version: 0.2.8
 Summary: Documentation for `weco`, a CLI for using Weco AI's code optimizer.
 Author-email: Weco AI Team <contact@weco.ai>
 License: MIT
@@ -9,7 +9,7 @@ Keywords: AI,Code Optimization,Code Generation
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.12
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -20,13 +20,19 @@ Requires-Dist: build; extra == "dev"
 Requires-Dist: setuptools_scm; extra == "dev"
 Dynamic: license-file
 
-# Weco CLI – Code Optimizer for Machine Learning Engineers
+# Weco: The Evaluation-Driven AI Code Optimizer
 
 [![Python](https://img.shields.io/badge/Python-3.12.0-blue)](https://www.python.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 [![PyPI version](https://badge.fury.io/py/weco.svg)](https://badge.fury.io/py/weco)
+[![AIDE](https://img.shields.io/badge/AI--Driven_Exploration-arXiv-orange?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2502.13138)
 
-`weco` is a command-line interface for interacting with Weco AI's code optimizer, powered by [AI-Driven Exploration](https://arxiv.org/abs/2502.13138). It helps you automate the improvement of your code for tasks like GPU kernel optimization, feature engineering, model development, and prompt engineering.
+Weco systematically optimizes your code, guided directly by your evaluation metrics.
+
+Example applications include:
+
+- **GPU Kernel Optimization**: Reimplement PyTorch functions using CUDA, Triton or Metal, optimizing for `latency`, `throughput`, or `memory_bandwidth`.
+- **Model Development**: Tune feature transformations or architectures, optimizing for `validation_accuracy`, `AUC`, or `Sharpe Ratio`.
+- **Prompt Engineering**: Refine prompts for LLMs, optimizing for  `win_rate`, `relevance`, or `format_adherence`
 
 https://github.com/user-attachments/assets/cb724ef1-bff6-4757-b457-d3b2201ede81
 
@@ -40,37 +46,6 @@ The `weco` CLI leverages a tree search approach guided by Large Language Models
 
 ---
 
-## Example Use Cases
-
-Here's how `weco` can be applied to common ML engineering tasks:
-
-*   **GPU Kernel Optimization:**
-    *   **Goal:** Improve the speed or efficiency of low-level GPU code.
-    *   **How:** `weco` iteratively refines CUDA, Triton, Metal, or other kernel code specified in your `--source` file.
-    *   **`--eval-command`:** Typically runs a script that compiles the kernel, executes it, and benchmarks performance (e.g., latency, throughput).
-    *   **`--metric`:** Examples include `latency`, `throughput`, `TFLOPS`, `memory_bandwidth`. Optimize to `minimize` latency or `maximize` throughput.
-
-*   **Feature Engineering:**
-    *   **Goal:** Discover better data transformations or feature combinations for your machine learning models.
-    *   **How:** `weco` explores different processing steps or parameters within your feature transformation code (`--source`).
-    *   **`--eval-command`:** Executes a script that applies the features, trains/validates a model using those features, and prints a performance score.
-    *   **`--metric`:** Examples include `accuracy`, `AUC`, `F1-score`, `validation_loss`. Usually optimized to `maximize` accuracy/AUC/F1 or `minimize` loss.
-
-*   **Model Development:**
-    *   **Goal:** Tune hyperparameters or experiment with small architectural changes directly within your model's code.
-    *   **How:** `weco` modifies hyperparameter values (like learning rate, layer sizes if defined in the code) or structural elements in your model definition (`--source`).
-    *   **`--eval-command`:** Runs your model training and evaluation script, printing the key performance indicator.
-    *   **`--metric`:** Examples include `validation_accuracy`, `test_loss`, `inference_time`, `perplexity`. Optimize according to the metric's nature (e.g., `maximize` accuracy, `minimize` loss).
-
-*   **Prompt Engineering:**
-    *   **Goal:** Refine prompts used within larger systems (e.g., for LLM interactions) to achieve better or more consistent outputs.
-    *   **How:** `weco` modifies prompt templates, examples, or instructions stored in the `--source` file.
-    *   **`--eval-command`:** Executes a script that uses the prompt, generates an output, evaluates that output against desired criteria (e.g., using another LLM, checking for keywords, format validation), and prints a score.
-    *   **`--metric`:** Examples include `quality_score`, `relevance`, `task_success_rate`, `format_adherence`. Usually optimized to `maximize`.
-
----
-
-
 ## Setup
 
 1.  **Install the Package:**
@@ -97,70 +72,30 @@ Here's how `weco` can be applied to common ML engineering tasks:
 
 ---
 
-### Examples
+### Example: Optimizing Simple PyTorch Operations
+
+This basic example shows how to optimize a simple PyTorch function for speedup.
 
-**Example 1: Optimizing PyTorch simple operations**
+For more advanced examples, including **[Metal/MLX](/examples/metal/README.md), [Triton](/examples/triton/README.md), [CUDA kernel optimization](/examples/cuda/README.md)**, and **[ML model optimization](/examples/spaceship-titanic/README.md)t**, please see the `README.md` files within the corresponding subdirectories under the [`examples/`](./examples/) folder.
 
 ```bash
+# Navigate to the example directory
 cd examples/hello-kernel-world
-pip install torch 
+
+# Install dependencies
+pip install torch
+
+# Run Weco
 weco --source optimize.py \
      --eval-command "python evaluate.py --solution-path optimize.py --device cpu" \
      --metric speedup \
      --maximize true \
      --steps 15 \
-     --model claude-3-7-sonnet-20250219 \
+     --model gemini-2.5-pro-exp-03-25 \
      --additional-instructions "Fuse operations in the forward method while ensuring the max float deviation remains small. Maintain the same format of the code."
 ```
 
-Note that if you have an NVIDIA gpu, change the device to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
-
-**Example 2: Optimizing MLX operations with instructions from a file**
-
-Lets optimize a 2D convolution operation in [`mlx`](https://github.com/ml-explore/mlx) using [Metal](https://developer.apple.com/documentation/metal/). Sometimes, additional context or instructions are too complex for a single command-line string. You can provide a path to a file containing these instructions.
-
-```bash
-cd examples/metal
-pip install mlx
-weco --source optimize.py \
-     --eval-command "python evaluate.py --solution-path optimize.py" \
-     --metric speedup \
-     --maximize true \
-     --steps 30 \
-     --model o3-mini \
-     --additional-instructions examples.rst
-```
-
-**Example 3: Level Agnostic Optimization: Causal Self Attention with Triton & CUDA**
-
-Given how useful causal multihead self attention is to transformers, we've seen its wide adoption across ML engineering and AI research. Its great to keep things at a high-level (in PyTorch) when doing research, but when moving to production you often need to write highly customized low-level kernels to make things run as fast as they can. The `weco` CLI can optimize kernels across a variety of different abstraction levels and frameworks. Example 2 uses Metal but lets explore two more frameworks:
-
-1. [Triton](https://github.com/triton-lang/triton)
-    ```bash
-   cd examples/triton
-   pip install torch triton
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions "Use triton to optimize the code while ensuring a small max float diff. Maintain the same code format."
-   ```
-
-2. [CUDA](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html)
-   ```bash
-   cd examples/cuda
-   pip install torch
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions guide.md
-   ```
-
+**Note:** If you have an NVIDIA GPU, change the device in the `--eval-command` to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
 
 ---
 
@@ -169,16 +104,28 @@ Given how useful causal multihead self attention is to transformers, we've seen
 | Argument                    | Description                                                                                                                                                              | Required |
 | :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
 | `--source`                  | Path to the source code file that will be optimized (e.g., `optimize.py`).                                                                                               | Yes      |
-| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below. | Yes      |
-| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.            | Yes      |
+| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below.     | Yes      |
+| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.                | Yes      |
 | `--maximize`                | Whether to maximize (`true`) or minimize (`false`) the metric.                                                                                                           | Yes      |
 | `--steps`                   | Number of optimization steps (LLM iterations) to run.                                                                                                                    | Yes      |
-| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.        | Yes      |
-| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                       | No       |
+| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.| Yes      |
+| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                    | No       |
+| `--log-dir`                 | (Optional) Path to the directory to log intermediate steps and final optimization result. Defaults to `.runs/`.                                                          | No       |
 
 ---
 
+### Performance & Expectations
+
+Weco, powered by the AIDE algorithm, optimizes code iteratively based on your evaluation results. Achieving significant improvements, especially on complex research-level tasks, often requires substantial exploration time.
 
+The following plot from the independent [Research Engineering Benchmark (RE-Bench)](https://metr.org/AI_R_D_Evaluation_Report.pdf) report shows the performance of AIDE (the algorithm behind Weco) on challenging ML research engineering tasks over different time budgets.
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ff0e471d-2f50-4e2d-b718-874862f533df" alt="RE-Bench Performance Across Time" width="60%"/>
+</p>
+
+As shown, AIDE demonstrates strong performance gains over time, surpassing lower human expert percentiles within hours and continuing to improve. This highlights the potential of evaluation-driven optimization but also indicates that reaching high levels of performance comparable to human experts on difficult benchmarks can take considerable time (tens of hours in this specific benchmark, corresponding to many `--steps` in the Weco CLI). Factor this into your planning when setting the number of `--steps` for your optimization runs.
+
+---
 
 ### Important Note on Evaluation
 

{weco-0.2.6 → weco-0.2.8}/README.md

@@ -1,10 +1,16 @@
-# Weco CLI – Code Optimizer for Machine Learning Engineers
+# Weco: The Evaluation-Driven AI Code Optimizer
 
 [![Python](https://img.shields.io/badge/Python-3.12.0-blue)](https://www.python.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 [![PyPI version](https://badge.fury.io/py/weco.svg)](https://badge.fury.io/py/weco)
+[![AIDE](https://img.shields.io/badge/AI--Driven_Exploration-arXiv-orange?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2502.13138)
 
-`weco` is a command-line interface for interacting with Weco AI's code optimizer, powered by [AI-Driven Exploration](https://arxiv.org/abs/2502.13138). It helps you automate the improvement of your code for tasks like GPU kernel optimization, feature engineering, model development, and prompt engineering.
+Weco systematically optimizes your code, guided directly by your evaluation metrics.
+
+Example applications include:
+
+- **GPU Kernel Optimization**: Reimplement PyTorch functions using CUDA, Triton or Metal, optimizing for `latency`, `throughput`, or `memory_bandwidth`.
+- **Model Development**: Tune feature transformations or architectures, optimizing for `validation_accuracy`, `AUC`, or `Sharpe Ratio`.
+- **Prompt Engineering**: Refine prompts for LLMs, optimizing for  `win_rate`, `relevance`, or `format_adherence`
 
 https://github.com/user-attachments/assets/cb724ef1-bff6-4757-b457-d3b2201ede81
 
@@ -18,37 +24,6 @@ The `weco` CLI leverages a tree search approach guided by Large Language Models
 
 ---
 
-## Example Use Cases
-
-Here's how `weco` can be applied to common ML engineering tasks:
-
-*   **GPU Kernel Optimization:**
-    *   **Goal:** Improve the speed or efficiency of low-level GPU code.
-    *   **How:** `weco` iteratively refines CUDA, Triton, Metal, or other kernel code specified in your `--source` file.
-    *   **`--eval-command`:** Typically runs a script that compiles the kernel, executes it, and benchmarks performance (e.g., latency, throughput).
-    *   **`--metric`:** Examples include `latency`, `throughput`, `TFLOPS`, `memory_bandwidth`. Optimize to `minimize` latency or `maximize` throughput.
-
-*   **Feature Engineering:**
-    *   **Goal:** Discover better data transformations or feature combinations for your machine learning models.
-    *   **How:** `weco` explores different processing steps or parameters within your feature transformation code (`--source`).
-    *   **`--eval-command`:** Executes a script that applies the features, trains/validates a model using those features, and prints a performance score.
-    *   **`--metric`:** Examples include `accuracy`, `AUC`, `F1-score`, `validation_loss`. Usually optimized to `maximize` accuracy/AUC/F1 or `minimize` loss.
-
-*   **Model Development:**
-    *   **Goal:** Tune hyperparameters or experiment with small architectural changes directly within your model's code.
-    *   **How:** `weco` modifies hyperparameter values (like learning rate, layer sizes if defined in the code) or structural elements in your model definition (`--source`).
-    *   **`--eval-command`:** Runs your model training and evaluation script, printing the key performance indicator.
-    *   **`--metric`:** Examples include `validation_accuracy`, `test_loss`, `inference_time`, `perplexity`. Optimize according to the metric's nature (e.g., `maximize` accuracy, `minimize` loss).
-
-*   **Prompt Engineering:**
-    *   **Goal:** Refine prompts used within larger systems (e.g., for LLM interactions) to achieve better or more consistent outputs.
-    *   **How:** `weco` modifies prompt templates, examples, or instructions stored in the `--source` file.
-    *   **`--eval-command`:** Executes a script that uses the prompt, generates an output, evaluates that output against desired criteria (e.g., using another LLM, checking for keywords, format validation), and prints a score.
-    *   **`--metric`:** Examples include `quality_score`, `relevance`, `task_success_rate`, `format_adherence`. Usually optimized to `maximize`.
-
----
-
-
 ## Setup
 
 1.  **Install the Package:**
@@ -75,70 +50,30 @@ Here's how `weco` can be applied to common ML engineering tasks:
 
 ---
 
-### Examples
+### Example: Optimizing Simple PyTorch Operations
+
+This basic example shows how to optimize a simple PyTorch function for speedup.
 
-**Example 1: Optimizing PyTorch simple operations**
+For more advanced examples, including **[Metal/MLX](/examples/metal/README.md), [Triton](/examples/triton/README.md), [CUDA kernel optimization](/examples/cuda/README.md)**, and **[ML model optimization](/examples/spaceship-titanic/README.md)t**, please see the `README.md` files within the corresponding subdirectories under the [`examples/`](./examples/) folder.
 
 ```bash
+# Navigate to the example directory
 cd examples/hello-kernel-world
-pip install torch 
+
+# Install dependencies
+pip install torch
+
+# Run Weco
 weco --source optimize.py \
      --eval-command "python evaluate.py --solution-path optimize.py --device cpu" \
      --metric speedup \
      --maximize true \
      --steps 15 \
-     --model claude-3-7-sonnet-20250219 \
+     --model gemini-2.5-pro-exp-03-25 \
      --additional-instructions "Fuse operations in the forward method while ensuring the max float deviation remains small. Maintain the same format of the code."
 ```
 
-Note that if you have an NVIDIA gpu, change the device to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
-
-**Example 2: Optimizing MLX operations with instructions from a file**
-
-Lets optimize a 2D convolution operation in [`mlx`](https://github.com/ml-explore/mlx) using [Metal](https://developer.apple.com/documentation/metal/). Sometimes, additional context or instructions are too complex for a single command-line string. You can provide a path to a file containing these instructions.
-
-```bash
-cd examples/metal
-pip install mlx
-weco --source optimize.py \
-     --eval-command "python evaluate.py --solution-path optimize.py" \
-     --metric speedup \
-     --maximize true \
-     --steps 30 \
-     --model o3-mini \
-     --additional-instructions examples.rst
-```
-
-**Example 3: Level Agnostic Optimization: Causal Self Attention with Triton & CUDA**
-
-Given how useful causal multihead self attention is to transformers, we've seen its wide adoption across ML engineering and AI research. Its great to keep things at a high-level (in PyTorch) when doing research, but when moving to production you often need to write highly customized low-level kernels to make things run as fast as they can. The `weco` CLI can optimize kernels across a variety of different abstraction levels and frameworks. Example 2 uses Metal but lets explore two more frameworks:
-
-1. [Triton](https://github.com/triton-lang/triton)
-    ```bash
-   cd examples/triton
-   pip install torch triton
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions "Use triton to optimize the code while ensuring a small max float diff. Maintain the same code format."
-   ```
-
-2. [CUDA](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html)
-   ```bash
-   cd examples/cuda
-   pip install torch
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions guide.md
-   ```
-
+**Note:** If you have an NVIDIA GPU, change the device in the `--eval-command` to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
 
 ---
 
@@ -147,16 +82,28 @@ Given how useful causal multihead self attention is to transformers, we've seen
 | Argument                    | Description                                                                                                                                                              | Required |
 | :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
 | `--source`                  | Path to the source code file that will be optimized (e.g., `optimize.py`).                                                                                               | Yes      |
-| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below. | Yes      |
-| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.            | Yes      |
+| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below.     | Yes      |
+| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.                | Yes      |
 | `--maximize`                | Whether to maximize (`true`) or minimize (`false`) the metric.                                                                                                           | Yes      |
 | `--steps`                   | Number of optimization steps (LLM iterations) to run.                                                                                                                    | Yes      |
-| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.        | Yes      |
-| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                       | No       |
+| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.| Yes      |
+| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                    | No       |
+| `--log-dir`                 | (Optional) Path to the directory to log intermediate steps and final optimization result. Defaults to `.runs/`.                                                          | No       |
 
 ---
 
+### Performance & Expectations
+
+Weco, powered by the AIDE algorithm, optimizes code iteratively based on your evaluation results. Achieving significant improvements, especially on complex research-level tasks, often requires substantial exploration time.
 
+The following plot from the independent [Research Engineering Benchmark (RE-Bench)](https://metr.org/AI_R_D_Evaluation_Report.pdf) report shows the performance of AIDE (the algorithm behind Weco) on challenging ML research engineering tasks over different time budgets.
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ff0e471d-2f50-4e2d-b718-874862f533df" alt="RE-Bench Performance Across Time" width="60%"/>
+</p>
+
+As shown, AIDE demonstrates strong performance gains over time, surpassing lower human expert percentiles within hours and continuing to improve. This highlights the potential of evaluation-driven optimization but also indicates that reaching high levels of performance comparable to human experts on difficult benchmarks can take considerable time (tens of hours in this specific benchmark, corresponding to many `--steps` in the Weco CLI). Factor this into your planning when setting the number of `--steps` for your optimization runs.
+
+---
 
 ### Important Note on Evaluation
 

weco-0.2.8/examples/cuda/README.md

@@ -0,0 +1,40 @@
+# Example: Optimizing PyTorch Self-Attention with CUDA
+
+This example showcases using Weco to optimize a PyTorch causal multi-head self-attention implementation by generating custom [CUDA](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html) kernels. This approach aims for low-level optimization beyond standard PyTorch or even Triton for potentially higher performance on NVIDIA GPUs.
+
+This example uses a separate Markdown file (`guide.md`) to provide detailed instructions and context to the LLM.
+
+## Setup
+
+1.  Ensure you are in the `examples/cuda` directory.
+2.  Install the required dependency:
+    ```bash
+    pip install torch
+    ```
+    *(Note: This example requires a compatible NVIDIA GPU and the CUDA Toolkit installed on your system for compiling and running the generated CUDA code.)*
+
+## Optimization Command
+
+Run the following command to start the optimization process:
+
+```bash
+weco --source optimize.py \
+     --eval-command "python evaluate.py --solution-path optimize.py" \
+     --metric speedup \
+     --maximize true \
+     --steps 30 \
+     --model gemini-2.5-pro-exp-03-25 \
+     --additional-instructions guide.md
+```
+
+### Explanation
+
+*   `--source optimize.py`: The initial PyTorch self-attention code to be optimized with CUDA.
+*   `--eval-command "python evaluate.py --solution-path optimize.py"`: Runs the evaluation script, which compiles (if necessary) and benchmarks the CUDA-enhanced code in `optimize.py` against a baseline, printing the `speedup`.
+*   `--metric speedup`: The optimization target metric.
+*   `--maximize true`: Weco aims to increase the speedup.
+*   `--steps 30`: The number of optimization iterations.
+*   `--model gemini-2.5-pro-exp-03-25`: The LLM used for code generation.
+*   `--additional-instructions guide.md`: Points Weco to a file containing detailed instructions for the LLM on how to write the CUDA kernels, handle compilation (e.g., using `torch.utils.cpp_extension`), manage data types, and ensure correctness.
+
+Weco will iteratively modify `optimize.py`, potentially generating and integrating CUDA C++ code, guided by the evaluation results and the instructions in `guide.md`.

weco-0.2.8/examples/spaceship-titanic/README.md

@@ -0,0 +1,62 @@
+# Example: Optimizing a Kaggle Classification Model (Spaceship Titanic)
+
+This example demonstrates using Weco to optimize a Python script designed for the [Spaceship Titanic Kaggle competition](https://www.kaggle.com/competitions/spaceship-titanic/overview). The goal is to improve the model's `accuracy` metric by modifying the feature engineering and modeling steps within the `optimize.py` script.
+
+This example uses the `README.md` file (this file) to provide additional instructions to the LLM.
+
+## Setup
+
+1.  Ensure you are in the `examples/spaceship-titanic` directory.
+2.  **Kaggle Credentials:** You need your Kaggle API credentials (`kaggle.json`) configured to download the competition dataset. Place the `kaggle.json` file in `~/.kaggle/` or set the `KAGGLE_USERNAME` and `KAGGLE_KEY` environment variables. See [Kaggle API documentation](https://github.com/Kaggle/kaggle-api#api-credentials) for details.
+3.  **Install Dependencies:** Install the required Python packages:
+    ```bash
+    pip install -r requirements-test.txt
+    ```
+4.  **Prepare Data:** Run the utility script once to download the dataset from Kaggle and place it in the expected `public/` and `private/` subdirectories:
+    ```bash
+    python utils.py
+    ```
+    After running `utils.py`, your directory structure should look like this:
+    ```
+    .
+    ├── baseline.py
+    ├── evaluate.py
+    ├── optimize.py
+    ├── private
+    │   └── test.csv
+    ├── public
+    │   ├── sample_submission.csv
+    │   ├── test.csv
+    │   └── train.csv
+    ├── README.md  # This file
+    ├── requirements-test.txt
+    └── utils.py
+    ```
+
+## Optimization Command
+
+Run the following command to start optimizing the model:
+
+```bash
+weco --source optimize.py \
+     --eval-command "python optimize.py && python evaluate.py" \
+     --metric accuracy \
+     --maximize true \
+     --steps 10 \
+     --model gemini-2.5-pro-exp-03-25 \
+     --additional-instructions README.md
+```
+
+### Explanation
+
+*   `--source optimize.py`: The script containing the model training and prediction logic to be optimized. It starts identical to `baseline.py`.
+*   `--eval-command "python optimize.py && python evaluate.py"`: This is a multi-step evaluation.
+    *   `python optimize.py`: Runs the modified script to generate predictions (`submission.csv`).
+    *   `python evaluate.py`: Compares the generated `submission.csv` against the ground truth (using the training data as a proxy evaluation set in this example) and prints the `accuracy` metric.
+*   `--metric accuracy`: The target metric Weco should optimize.
+*   `--maximize true`: Weco aims to increase the accuracy.
+*   `--steps 10`: The number of optimization iterations.
+*   `--model gemini-2.5-pro-exp-03-25`: The LLM driving the optimization.
+*   `--additional-instructions README.md`: Provides this file as context to the LLM, which might include hints about feature engineering techniques, model types to try, or specific data columns to focus on (you can add such instructions to this file if desired).
+
+Weco will iteratively modify the feature engineering or modeling code within `optimize.py`, run the evaluation pipeline, and use the resulting `accuracy` to guide further improvements. The `baseline.py` file is provided as a reference starting point.

weco-0.2.8/examples/spaceship-titanic/baseline.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+import pandas as pd
+
+
+def predict(test: Path, save: Path):
+    # TODO: Add a model here
+
+    test_data = pd.read_csv(test)
+    submission = pd.DataFrame({"PassengerId": test_data["PassengerId"], "Transported": False})
+    submission.to_csv(save, index=False)
+    print(f"Test submission saved to {save}")
+
+
+if __name__ == "__main__":
+    # This block is primarily for testing the script directly,
+    # it's not used by the weco evaluation loop.
+    script_dir = Path(__file__).resolve().parent
+    # Use validation data as test data *for this test block only*
+    train_file_path = script_dir / "public" / "train.csv"
+    print("train_file_path:", train_file_path)
+    test_file_path = script_dir / "public" / "test.csv"
+    print("test_file_path:", test_file_path)
+    submission_output_path = script_dir / "submission.csv"
+
+    # Call predict with the DataFrame and the correct output path
+    predict(train_file_path, test_file_path, submission_output_path)
+    print(f"Test submission saved to {submission_output_path}")

weco-0.2.8/examples/spaceship-titanic/evaluate.py

@@ -0,0 +1,71 @@
+import sys
+import pandas as pd
+from sklearn.metrics import accuracy_score
+from pathlib import Path
+
+
+class InvalidSubmissionError(Exception):
+    """
+    A custom exception for when the agent submission cannot be graded.
+    """
+
+    pass
+
+
+def prepare_for_accuracy_metric(submission: pd.DataFrame, answers: pd.DataFrame, target_column: str, id_column: str) -> dict:
+    # Answers checks
+    assert target_column in answers.columns, f"Answers must have a `{target_column}` column"
+    assert id_column in answers.columns, f"Answers must have a `{id_column}` column"
+
+    # Submission checks
+    if len(submission) != len(answers):
+        raise InvalidSubmissionError("Submission must have the same length as the answers.")
+    if target_column not in submission.columns:
+        raise InvalidSubmissionError(f"Submission must have a `{target_column}` column")
+    if id_column not in submission.columns:
+        raise InvalidSubmissionError(f"Submission must have a `{id_column}` column")
+
+    # sort on id to ensure correct order
+    submission = submission.sort_values(id_column)
+    answers = answers.sort_values(id_column)
+
+    if (submission[id_column].values != answers[id_column].values).any():
+        raise InvalidSubmissionError(f"Submission and Answers `{id_column}`'s do not match")
+
+    y_pred = submission[target_column].to_numpy()
+    y_true = answers[target_column].to_numpy()
+
+    return {"y_true": y_true, "y_pred": y_pred}
+
+
+def grade(submission: pd.DataFrame, answers: pd.DataFrame) -> float:
+    accuracy_inputs = prepare_for_accuracy_metric(
+        submission=submission, answers=answers, target_column="Transported", id_column="PassengerId"
+    )
+    return accuracy_score(**accuracy_inputs)
+
+
+if __name__ == "__main__":
+    # Get the directory where the script is located
+    script_dir = Path(__file__).resolve().parent
+    # The ground truth answers are now in private/test.csv
+    answers_path = script_dir / "private" / "test.csv"
+    # Assume the agent's submission is saved here
+    submission_path = script_dir / "submission.csv"
+
+    # Check if files exist before proceeding
+    if not answers_path.exists():
+        print(f"Error: Answers file not found at {answers_path}")  # Updated path in error message
+        sys.exit(1)
+
+    if not submission_path.exists():
+        print(f"Error: Submission file not found at {submission_path}")
+        sys.exit(1)
+
+    submission = pd.read_csv(submission_path)
+    # Read answers from the updated path
+    answers = pd.read_csv(answers_path)
+
+    # Calculate and print the grade
+    score = grade(submission, answers)
+    print(f"accuracy: {score}")

weco-0.2.8/examples/spaceship-titanic/optimize.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+import pandas as pd
+
+
+def predict(test: Path, save: Path):
+    # TODO: Add a model here
+
+    test_data = pd.read_csv(test)
+    submission = pd.DataFrame({"PassengerId": test_data["PassengerId"], "Transported": False})
+    submission.to_csv(save, index=False)
+    print(f"Test submission saved to {save}")
+
+
+if __name__ == "__main__":
+    # This block is primarily for testing the script directly,
+    # it's not used by the weco evaluation loop.
+    script_dir = Path(__file__).resolve().parent
+    # Use validation data as test data *for this test block only*
+    train_file_path = script_dir / "public" / "train.csv"
+    print("train_file_path:", train_file_path)
+    test_file_path = script_dir / "public" / "test.csv"
+    print("test_file_path:", test_file_path)
+    submission_output_path = script_dir / "submission.csv"
+
+    # Call predict with the DataFrame and the correct output path
+    predict(train_file_path, test_file_path, submission_output_path)
+    print(f"Test submission saved to {submission_output_path}")

weco-0.2.8/examples/spaceship-titanic/requirements-test.txt

@@ -0,0 +1,8 @@
+pandas
+numpy
+scikit-learn
+torch
+xgboost
+lightgbm
+catboost
+kaggle

weco-0.2.8/examples/spaceship-titanic/utils.py

@@ -0,0 +1,56 @@
+import pandas as pd
+from sklearn.model_selection import train_test_split
+from pathlib import Path
+import kaggle
+import zipfile
+import os
+
+
+def prepare_data():
+    kaggle.api.competition_download_files("spaceship-titanic")
+    # unzip the data
+    with zipfile.ZipFile("spaceship-titanic.zip", "r") as zip_ref:
+        zip_ref.extractall()
+    # remove the zip file
+    os.remove("spaceship-titanic.zip")
+
+
+def split_data(public: Path, private: Path):
+    df = pd.read_csv("train.csv")
+    # Use a fixed random_state for reproducibility
+    new_train, new_test = train_test_split(df, test_size=0.1, random_state=0)
+
+    os.makedirs(public, exist_ok=True)
+    os.makedirs(private, exist_ok=True)
+
+    example_submission = new_test[["PassengerId", "Transported"]].copy()
+    example_submission["Transported"] = False
+    example_submission.to_csv(public / "sample_submission.csv", index=False)
+
+    new_train.to_csv(public / "train.csv", index=False)
+    print("training sample shape:", new_train.shape)
+    new_test.to_csv(private / "test.csv", index=False)
+    print("test sample shape:", new_test.shape)
+    print(f"Validation data saved to {public / 'test.csv'}")
+    new_test.drop("Transported", axis="columns").to_csv(public / "test.csv", index=False)
+
+    # remove the previous files
+    os.remove("train.csv")
+    os.remove("sample_submission.csv")
+
+
+def setup_data():
+    # download the data
+    prepare_data()
+
+    # Get the directory where the script is located
+    script_dir = Path(__file__).resolve().parent
+    public_path = script_dir / "public"
+    private_path = script_dir / "private"
+
+    # split the data
+    split_data(public_path, private_path)
+
+
+if __name__ == "__main__":
+    setup_data()

{weco-0.2.6 → weco-0.2.8}/pyproject.toml

@@ -10,9 +10,9 @@ authors = [
 ]
 description = "Documentation for `weco`, a CLI for using Weco AI's code optimizer."
 readme = "README.md"
-version = "0.2.6"
+version = "0.2.8"
 license = {text = "MIT"}
-requires-python = ">=3.12"
+requires-python = ">=3.8"
 dependencies = ["requests", "rich"]
 keywords = ["AI", "Code Optimization", "Code Generation"]
 classifiers = [

{weco-0.2.6 → weco-0.2.8}/weco/__init__.py

@@ -1,4 +1,4 @@
 # DO NOT EDIT
-__pkg_version__ = "0.2.6"
+__pkg_version__ = "0.2.8"
 __api_version__ = "v1"
 __base_url__ = f"https://api.aide.weco.ai/{__api_version__}"

{weco-0.2.6 → weco-0.2.8}/weco/api.py

@@ -6,14 +6,9 @@ import sys
 
 
 def handle_api_error(e: requests.exceptions.HTTPError, console: rich.console.Console) -> None:
-    """Extract and display error messages from API responses."""
-    try:
-        error_data = e.response.json()
-        error_message = error_data.get("detail", str(e))
-        console.print(f"[bold red]Server Error:[/] {error_message}")
-    except Exception:
-        # If we can't parse the JSON, just show the original error
-        console.print(f"[bold red]Server Error:[/] {str(e)}")
+    """Extract and display error messages from API responses in a structured format."""
+    error_message = str(e)  # Default message
+    console.print(f"[bold red]Error:[/] {error_message}")
     sys.exit(1)
 
 

{weco-0.2.6 → weco-0.2.8}/weco/cli.py

@@ -36,7 +36,7 @@ def main() -> None:
     parser = argparse.ArgumentParser(
         description="[bold cyan]Weco CLI[/]", formatter_class=argparse.RawDescriptionHelpFormatter
     )
-    parser.add_argument("--source", type=str, required=True, help="Path to the Python source code (e.g. optimize.py)")
+    parser.add_argument("--source", type=str, required=True, help="Path to the source code (e.g. optimize.py)")
     parser.add_argument(
         "--eval-command", type=str, required=True, help="Command to run for evaluation (e.g. 'python eval.py --arg1=val1')"
     )
@@ -50,6 +50,7 @@ def main() -> None:
     )
     parser.add_argument("--steps", type=int, required=True, help="Number of steps to run")
     parser.add_argument("--model", type=str, required=True, help="Model to use for optimization")
+    parser.add_argument("--log-dir", type=str, default=".runs", help="Directory to store logs and results")
     parser.add_argument(
         "--additional-instructions",
         default=None,
@@ -83,9 +84,11 @@ def main() -> None:
             timeout = 800
 
         # Initialize panels
-        summary_panel = SummaryPanel(maximize=maximize, metric_name=metric_name, total_steps=steps, model=args.model)
+        summary_panel = SummaryPanel(
+            maximize=maximize, metric_name=metric_name, total_steps=steps, model=args.model, runs_dir=args.log_dir
+        )
         plan_panel = PlanPanel()
-        solution_panels = SolutionPanels(metric_name=metric_name)
+        solution_panels = SolutionPanels(metric_name=metric_name, source_fp=source_fp)
         eval_output_panel = EvaluationOutputPanel()
         tree_panel = MetricTreePanel(maximize=maximize)
         layout = create_optimization_layout()
@@ -112,11 +115,11 @@ def main() -> None:
         with Live(layout, refresh_per_second=refresh_rate, screen=True) as live:
             # Define the runs directory (.runs/<session-id>)
             session_id = session_response["session_id"]
-            runs_dir = pathlib.Path(".runs") / session_id
+            runs_dir = pathlib.Path(args.log_dir) / session_id
             runs_dir.mkdir(parents=True, exist_ok=True)
 
-            # Save the original code (.runs/<session-id>/original.py)
-            runs_copy_source_fp = runs_dir / "original.py"
+            # Save the original code (.runs/<session-id>/original.<extension>)
+            runs_copy_source_fp = runs_dir / f"original.{source_fp.suffix}"
             write_to_path(fp=runs_copy_source_fp, content=source_code)
 
             # Write the code string to the source file path
@@ -197,8 +200,8 @@ def main() -> None:
                     api_keys=api_keys,
                     timeout=timeout,
                 )
-                # Save next solution (.runs/<session-id>/step_<step>.py)
-                write_to_path(fp=runs_dir / f"step_{step}.py", content=eval_and_next_solution_response["code"])
+                # Save next solution (.runs/<session-id>/step_<step>.<extension>)
+                write_to_path(fp=runs_dir / f"step_{step}.{source_fp.suffix}", content=eval_and_next_solution_response["code"])
 
                 # Write the next solution to the source file
                 write_to_path(fp=source_fp, content=eval_and_next_solution_response["code"])
@@ -348,8 +351,8 @@ def main() -> None:
                 )
                 best_solution_content = f"# Best solution from Weco with a score of {best_score_str}\n\n{best_solution_code}"
 
-            # Save best solution to .runs/<session-id>/best.py
-            write_to_path(fp=runs_dir / "best.py", content=best_solution_content)
+            # Save best solution to .runs/<session-id>/best.<extension>
+            write_to_path(fp=runs_dir / f"best.{source_fp.suffix}", content=best_solution_content)
 
             # write the best solution to the source file
             write_to_path(fp=source_fp, content=best_solution_content)

{weco-0.2.6 → weco-0.2.8}/weco/panels.py

@@ -6,12 +6,13 @@ from rich.panel import Panel
 from rich.syntax import Syntax
 from typing import Dict, List, Optional, Union, Tuple
 from .utils import format_number
+import pathlib
 
 
 class SummaryPanel:
     """Holds a summary of the optimization session."""
 
-    def __init__(self, maximize: bool, metric_name: str, total_steps: int, model: str, session_id: str = None):
+    def __init__(self, maximize: bool, metric_name: str, total_steps: int, model: str, runs_dir: str, session_id: str = None):
         self.maximize = maximize
         self.metric_name = metric_name
         self.goal = ("Maximizing" if self.maximize else "Minimizing") + f" {self.metric_name}..."
@@ -19,7 +20,8 @@ class SummaryPanel:
         self.total_output_tokens = 0
         self.total_steps = total_steps
         self.model = model
-        self.session_id = session_id or "N/A"
+        self.runs_dir = runs_dir
+        self.session_id = session_id if session_id is not None else "N/A"
         self.progress = Progress(
             TextColumn("[progress.description]{task.description}"),
             BarColumn(bar_width=20),
@@ -45,6 +47,8 @@ class SummaryPanel:
         """Create a summary panel with the relevant information."""
         layout = Layout(name="summary")
         summary_table = Table(show_header=False, box=None, padding=(0, 1))
+
+        summary_table.add_row("")
         # Goal
         if final_message is not None:
             summary_table.add_row(f"[bold cyan]Result:[/] {final_message}")
@@ -55,8 +59,7 @@ class SummaryPanel:
         summary_table.add_row(f"[bold cyan]Model:[/] {self.model}")
         summary_table.add_row("")
         # Log directory
-        runs_dir = f".runs/{self.session_id}"
-        summary_table.add_row(f"[bold cyan]Logs:[/] [blue underline]{runs_dir}[/]")
+        summary_table.add_row(f"[bold cyan]Logs:[/] [blue underline]{self.runs_dir}/{self.session_id}[/]")
         summary_table.add_row("")
         # Token counts
         summary_table.add_row(
@@ -256,13 +259,19 @@ class EvaluationOutputPanel:
 class SolutionPanels:
     """Displays the current and best solutions side by side."""
 
-    def __init__(self, metric_name: str):
+    def __init__(self, metric_name: str, source_fp: pathlib.Path):
         # Current solution
         self.current_node = None
         # Best solution
         self.best_node = None
         # Metric name
         self.metric_name = metric_name.capitalize()
+        # Determine the lexer for the source file
+        self.lexer = self._determine_lexer(source_fp)
+
+    def _determine_lexer(self, source_fp: pathlib.Path) -> str:
+        """Determine the lexer for the source file."""
+        return Syntax.from_path(source_fp).lexer
 
     def update(self, current_node: Union[Node, None], best_node: Union[Node, None]):
         """Update the current and best solutions."""
@@ -280,7 +289,7 @@ class SolutionPanels:
         # Current solution (without score)
         current_title = f"[bold]💡 Current Solution (Step {current_step})"
         current_panel = Panel(
-            Syntax(str(current_code), "python", theme="monokai", line_numbers=True, word_wrap=False),
+            Syntax(str(current_code), self.lexer, theme="monokai", line_numbers=True, word_wrap=False),
             title=current_title,
             border_style="yellow",
             expand=True,
@@ -290,7 +299,7 @@ class SolutionPanels:
         # Best solution
         best_title = f"[bold]🏆 Best Solution ([green]{self.metric_name}: {f'{best_score:.4f}' if best_score is not None else 'N/A'}[/])"
         best_panel = Panel(
-            Syntax(str(best_code), "python", theme="monokai", line_numbers=True, word_wrap=False),
+            Syntax(str(best_code), self.lexer, theme="monokai", line_numbers=True, word_wrap=False),
             title=best_title,
             border_style="green",
             expand=True,

{weco-0.2.6 → weco-0.2.8}/weco.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: weco
-Version: 0.2.6
+Version: 0.2.8
 Summary: Documentation for `weco`, a CLI for using Weco AI's code optimizer.
 Author-email: Weco AI Team <contact@weco.ai>
 License: MIT
@@ -9,7 +9,7 @@ Keywords: AI,Code Optimization,Code Generation
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.12
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -20,13 +20,19 @@ Requires-Dist: build; extra == "dev"
 Requires-Dist: setuptools_scm; extra == "dev"
 Dynamic: license-file
 
-# Weco CLI – Code Optimizer for Machine Learning Engineers
+# Weco: The Evaluation-Driven AI Code Optimizer
 
 [![Python](https://img.shields.io/badge/Python-3.12.0-blue)](https://www.python.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 [![PyPI version](https://badge.fury.io/py/weco.svg)](https://badge.fury.io/py/weco)
+[![AIDE](https://img.shields.io/badge/AI--Driven_Exploration-arXiv-orange?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2502.13138)
 
-`weco` is a command-line interface for interacting with Weco AI's code optimizer, powered by [AI-Driven Exploration](https://arxiv.org/abs/2502.13138). It helps you automate the improvement of your code for tasks like GPU kernel optimization, feature engineering, model development, and prompt engineering.
+Weco systematically optimizes your code, guided directly by your evaluation metrics.
+
+Example applications include:
+
+- **GPU Kernel Optimization**: Reimplement PyTorch functions using CUDA, Triton or Metal, optimizing for `latency`, `throughput`, or `memory_bandwidth`.
+- **Model Development**: Tune feature transformations or architectures, optimizing for `validation_accuracy`, `AUC`, or `Sharpe Ratio`.
+- **Prompt Engineering**: Refine prompts for LLMs, optimizing for  `win_rate`, `relevance`, or `format_adherence`
 
 https://github.com/user-attachments/assets/cb724ef1-bff6-4757-b457-d3b2201ede81
 
@@ -40,37 +46,6 @@ The `weco` CLI leverages a tree search approach guided by Large Language Models
 
 ---
 
-## Example Use Cases
-
-Here's how `weco` can be applied to common ML engineering tasks:
-
-*   **GPU Kernel Optimization:**
-    *   **Goal:** Improve the speed or efficiency of low-level GPU code.
-    *   **How:** `weco` iteratively refines CUDA, Triton, Metal, or other kernel code specified in your `--source` file.
-    *   **`--eval-command`:** Typically runs a script that compiles the kernel, executes it, and benchmarks performance (e.g., latency, throughput).
-    *   **`--metric`:** Examples include `latency`, `throughput`, `TFLOPS`, `memory_bandwidth`. Optimize to `minimize` latency or `maximize` throughput.
-
-*   **Feature Engineering:**
-    *   **Goal:** Discover better data transformations or feature combinations for your machine learning models.
-    *   **How:** `weco` explores different processing steps or parameters within your feature transformation code (`--source`).
-    *   **`--eval-command`:** Executes a script that applies the features, trains/validates a model using those features, and prints a performance score.
-    *   **`--metric`:** Examples include `accuracy`, `AUC`, `F1-score`, `validation_loss`. Usually optimized to `maximize` accuracy/AUC/F1 or `minimize` loss.
-
-*   **Model Development:**
-    *   **Goal:** Tune hyperparameters or experiment with small architectural changes directly within your model's code.
-    *   **How:** `weco` modifies hyperparameter values (like learning rate, layer sizes if defined in the code) or structural elements in your model definition (`--source`).
-    *   **`--eval-command`:** Runs your model training and evaluation script, printing the key performance indicator.
-    *   **`--metric`:** Examples include `validation_accuracy`, `test_loss`, `inference_time`, `perplexity`. Optimize according to the metric's nature (e.g., `maximize` accuracy, `minimize` loss).
-
-*   **Prompt Engineering:**
-    *   **Goal:** Refine prompts used within larger systems (e.g., for LLM interactions) to achieve better or more consistent outputs.
-    *   **How:** `weco` modifies prompt templates, examples, or instructions stored in the `--source` file.
-    *   **`--eval-command`:** Executes a script that uses the prompt, generates an output, evaluates that output against desired criteria (e.g., using another LLM, checking for keywords, format validation), and prints a score.
-    *   **`--metric`:** Examples include `quality_score`, `relevance`, `task_success_rate`, `format_adherence`. Usually optimized to `maximize`.
-
----
-
-
 ## Setup
 
 1.  **Install the Package:**
@@ -97,70 +72,30 @@ Here's how `weco` can be applied to common ML engineering tasks:
 
 ---
 
-### Examples
+### Example: Optimizing Simple PyTorch Operations
+
+This basic example shows how to optimize a simple PyTorch function for speedup.
 
-**Example 1: Optimizing PyTorch simple operations**
+For more advanced examples, including **[Metal/MLX](/examples/metal/README.md), [Triton](/examples/triton/README.md), [CUDA kernel optimization](/examples/cuda/README.md)**, and **[ML model optimization](/examples/spaceship-titanic/README.md)t**, please see the `README.md` files within the corresponding subdirectories under the [`examples/`](./examples/) folder.
 
 ```bash
+# Navigate to the example directory
 cd examples/hello-kernel-world
-pip install torch 
+
+# Install dependencies
+pip install torch
+
+# Run Weco
 weco --source optimize.py \
      --eval-command "python evaluate.py --solution-path optimize.py --device cpu" \
      --metric speedup \
      --maximize true \
      --steps 15 \
-     --model claude-3-7-sonnet-20250219 \
+     --model gemini-2.5-pro-exp-03-25 \
      --additional-instructions "Fuse operations in the forward method while ensuring the max float deviation remains small. Maintain the same format of the code."
 ```
 
-Note that if you have an NVIDIA gpu, change the device to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
-
-**Example 2: Optimizing MLX operations with instructions from a file**
-
-Lets optimize a 2D convolution operation in [`mlx`](https://github.com/ml-explore/mlx) using [Metal](https://developer.apple.com/documentation/metal/). Sometimes, additional context or instructions are too complex for a single command-line string. You can provide a path to a file containing these instructions.
-
-```bash
-cd examples/metal
-pip install mlx
-weco --source optimize.py \
-     --eval-command "python evaluate.py --solution-path optimize.py" \
-     --metric speedup \
-     --maximize true \
-     --steps 30 \
-     --model o3-mini \
-     --additional-instructions examples.rst
-```
-
-**Example 3: Level Agnostic Optimization: Causal Self Attention with Triton & CUDA**
-
-Given how useful causal multihead self attention is to transformers, we've seen its wide adoption across ML engineering and AI research. Its great to keep things at a high-level (in PyTorch) when doing research, but when moving to production you often need to write highly customized low-level kernels to make things run as fast as they can. The `weco` CLI can optimize kernels across a variety of different abstraction levels and frameworks. Example 2 uses Metal but lets explore two more frameworks:
-
-1. [Triton](https://github.com/triton-lang/triton)
-    ```bash
-   cd examples/triton
-   pip install torch triton
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions "Use triton to optimize the code while ensuring a small max float diff. Maintain the same code format."
-   ```
-
-2. [CUDA](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html)
-   ```bash
-   cd examples/cuda
-   pip install torch
-   weco --source optimize.py \
-        --eval-command "python evaluate.py --solution-path optimize.py" \
-        --metric speedup \
-        --maximize true \
-        --steps 30 \
-        --model gemini-2.5-pro-preview-03-25 \
-        --additional-instructions guide.md
-   ```
-
+**Note:** If you have an NVIDIA GPU, change the device in the `--eval-command` to `cuda`. If you are running this on Apple Silicon, set it to `mps`.
 
 ---
 
@@ -169,16 +104,28 @@ Given how useful causal multihead self attention is to transformers, we've seen
 | Argument                    | Description                                                                                                                                                              | Required |
 | :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
 | `--source`                  | Path to the source code file that will be optimized (e.g., `optimize.py`).                                                                                               | Yes      |
-| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below. | Yes      |
-| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.            | Yes      |
+| `--eval-command`            | Command to run for evaluating the code in `--source`. This command should print the target `--metric` and its value to the terminal (stdout/stderr). See note below.     | Yes      |
+| `--metric`                  | The name of the metric you want to optimize (e.g., 'accuracy', 'speedup', 'loss'). This metric name should match what's printed by your `--eval-command`.                | Yes      |
 | `--maximize`                | Whether to maximize (`true`) or minimize (`false`) the metric.                                                                                                           | Yes      |
 | `--steps`                   | Number of optimization steps (LLM iterations) to run.                                                                                                                    | Yes      |
-| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.        | Yes      |
-| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                       | No       |
+| `--model`                   | Model identifier for the LLM to use (e.g., `gpt-4o`, `claude-3.5-sonnet`). Recommended models to try include `o3-mini`, `claude-3-haiku`, and `gemini-2.5-pro-exp-03-25`.| Yes      |
+| `--additional-instructions` | (Optional) Natural language description of specific instructions OR path to a file containing detailed instructions to guide the LLM.                                    | No       |
+| `--log-dir`                 | (Optional) Path to the directory to log intermediate steps and final optimization result. Defaults to `.runs/`.                                                          | No       |
 
 ---
 
+### Performance & Expectations
+
+Weco, powered by the AIDE algorithm, optimizes code iteratively based on your evaluation results. Achieving significant improvements, especially on complex research-level tasks, often requires substantial exploration time.
 
+The following plot from the independent [Research Engineering Benchmark (RE-Bench)](https://metr.org/AI_R_D_Evaluation_Report.pdf) report shows the performance of AIDE (the algorithm behind Weco) on challenging ML research engineering tasks over different time budgets.
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ff0e471d-2f50-4e2d-b718-874862f533df" alt="RE-Bench Performance Across Time" width="60%"/>
+</p>
+
+As shown, AIDE demonstrates strong performance gains over time, surpassing lower human expert percentiles within hours and continuing to improve. This highlights the potential of evaluation-driven optimization but also indicates that reaching high levels of performance comparable to human experts on difficult benchmarks can take considerable time (tens of hours in this specific benchmark, corresponding to many `--steps` in the Weco CLI). Factor this into your planning when setting the number of `--steps` for your optimization runs.
+
+---
 
 ### Important Note on Evaluation
 

{weco-0.2.6 → weco-0.2.8}/weco.egg-info/SOURCES.txt

@@ -4,14 +4,23 @@ README.md
 pyproject.toml
 .github/workflows/lint.yml
 .github/workflows/release.yml
+examples/cuda/README.md
 examples/cuda/evaluate.py
 examples/cuda/guide.md
 examples/cuda/optimize.py
 examples/hello-kernel-world/evaluate.py
 examples/hello-kernel-world/optimize.py
+examples/metal/README.md
 examples/metal/evaluate.py
 examples/metal/examples.rst
 examples/metal/optimize.py
+examples/spaceship-titanic/README.md
+examples/spaceship-titanic/baseline.py
+examples/spaceship-titanic/evaluate.py
+examples/spaceship-titanic/optimize.py
+examples/spaceship-titanic/requirements-test.txt
+examples/spaceship-titanic/utils.py
+examples/triton/README.md
 examples/triton/evaluate.py
 examples/triton/optimize.py
 weco/__init__.py