weco 0.1.10__py3-none-any.whl → 0.2.0__py3-none-any.whl

weco-0.2.0.dist-info/METADATA

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: weco
+Version: 0.2.0
+Summary: Documentation for `weco`, a CLI for using Weco AI's code optimizer.
+Author-email: Weco AI Team <dhruv@weco.ai>
+License: MIT
+Project-URL: Homepage, https://github.com/WecoAI/weco-cli
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
+Dynamic: license-file
+
+# Weco CLI – Optimize Your Code Effortlessly
+
+[![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)
+
+`weco` is a powerful command-line interface for interacting with Weco AI's code optimizer. Whether you are looking to improve performance or refine code quality, our CLI streamlines your workflow for a better development experience.
+
+---
+
+## Overview
+
+The `weco` CLI leverages advanced optimization techniques and language model strategies to iteratively improve your source code. It supports multiple language models and offers a flexible configuration to suit different optimization tasks.
+
+---
+
+## Setup
+
+1. **Install the Package:**
+
+   ```bash
+   pip install weco
+   ```
+
+2. **Configure API Keys:**
+
+   Set the appropriate environment variables for your language model provider:
+   
+   - **OpenAI:** `export OPENAI_API_KEY="your_key_here"`
+   - **Anthropic:** `export ANTHROPIC_API_KEY="your_key_here"`
+
+---
+
+## Usage
+
+### Command Line Arguments
+
+| Argument                    | Description                                                                                                                                   | Required |
+|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------|
+| `--source`                  | Path to the Python source code that will be optimized (e.g. optimize.py).                                                                    | Yes      |
+| `--eval-command`            | Command to run for evaluation (e.g. 'python eval.py --arg1=val1').                                                                            | Yes      |
+| `--metric`                  | Metric to optimize.                                                                                                                           | Yes      |
+| `--maximize`                | Boolean flag indicating whether to maximize the metric.                                                                                       | Yes      |
+| `--steps`                   | Number of optimization steps to run.                                                                                                          | Yes      |
+| `--model`                   | Model to use for optimization.                                                                                                                | Yes      |
+| `--additional-instructions` | (Optional) Description of additional instructions or path to a file containing additional instructions.                                       | No       |
+
+---
+
+### Example
+
+Optimizing common operations in pytorch:
+```bash
+weco --source examples/simple-torch/optimize.py \
+     --eval-command "python examples/simple-torch/evaluate.py --solution-path examples/simple-torch/optimize.py --device mps" \
+     --metric "speedup" \
+     --maximize true \
+     --steps 15 \
+     --model "o3-mini" \
+     --additional-instructions "Fuse operations in the forward method while ensuring the max float deviation remains small. Maintain the same format of the code."
+```
+
+Optimizing these same using mlx and metal:
+```bash
+weco --source examples/simple-mlx/optimize.py \
+     --eval-command "python examples/simple-mlx/evaluate.py --solution-path examples/simple-mlx/optimize.py" \
+     --metric "speedup" \
+     --maximize true \
+     --steps 30 \
+     --model "o3-mini" \
+     --additional-instructions "examples/simple-mlx/metal-examples.rst"
+```
+---
+
+## Supported Providers
+
+The CLI supports the following model providers:
+
+- **OpenAI:** Set your API key using `OPENAI_API_KEY`.
+- **Anthropic:** Set your API key using `ANTHROPIC_API_KEY`.
+
+---
+
+## Contributing
+
+We welcome contributions! To get started:
+
+1. **Fork and Clone the Repository:**
+   ```bash
+   git clone https://github.com/WecoAI/weco-cli.git
+   cd weco-cli
+   ```
+
+2. **Install Development Dependencies:**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+3. **Create a Feature Branch:**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+4. **Make Your Changes:** Ensure your code adheres to our style guidelines and includes relevant tests.
+
+5. **Commit and Push** your changes, then open a pull request with a clear description of your enhancements.
+
+---

weco-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+weco/__init__.py,sha256=J-pJsj20yEXYYCDJyhKJBFWQUzb4bhww0ynqxNBA5Z4,124
+weco/api.py,sha256=JHAm60sO51Y2tzLnyAAFv9OLm75o_RNWeoK-gYF4VHE,3342
+weco/cli.py,sha256=q1UuQ8xe2R5dpLhxPGJEW9mOFozH0oRlTbyyVD70XlU,15895
+weco/panels.py,sha256=Cu249CAlpczrseBjqvERlo_wlg4RLbO0ylx1JPZGjRA,13058
+weco/utils.py,sha256=yCVlQyCP0P7t-864xuw55qEUVmyXXGin-a1Y5TDFHE4,4202
+weco-0.2.0.dist-info/licenses/LICENSE,sha256=p_GQqJBvuZgkLNboYKyH-5dhpTDlKs2wq2TVM55WrWE,1065
+weco-0.2.0.dist-info/METADATA,sha256=piZk0o15yLjq6qpKKFQqT4vRcGR3unNC2LzZOIdJAro,5140
+weco-0.2.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+weco-0.2.0.dist-info/entry_points.txt,sha256=ixJ2uClALbCpBvnIR6BXMNck8SHAab8eVkM9pIUowcs,39
+weco-0.2.0.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
+weco-0.2.0.dist-info/RECORD,,

{weco-0.1.10.dist-info → weco-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

weco-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+weco = weco.cli:main

{weco-0.1.10.dist-info → weco-0.2.0.dist-info/licenses}/LICENSE

@@ -1,6 +1,7 @@
+
 MIT License
 
-Copyright (c) 2024 Weco AI
+Copyright (c) 2025 Weco AI
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal