Skip to content

Commit a240ed6

Browse files
Update README.md
1 parent 132b612 commit a240ed6

File tree

1 file changed

+3
-34
lines changed

1 file changed

+3
-34
lines changed

README.md

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77
[![PyPI version](https://badge.fury.io/py/weco.svg)](https://badge.fury.io/py/weco)
88
[![AIDE](https://img.shields.io/badge/AI--Driven_Exploration-arXiv-orange?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2502.13138)
99

10-
<code>pip install weco</code>
11-
1210
</div>
1311

1412
---
@@ -49,29 +47,9 @@ The `weco` CLI leverages a tree search approach guided by Large Language Models
4947
- **Anthropic:** `export ANTHROPIC_API_KEY="your_key_here"`
5048
- **Google DeepMind:** `export GEMINI_API_KEY="your_key_here"` (Google AI Studio has a free API usage quota. Create a key [here](https://aistudio.google.com/apikey) to use `weco` for free.)
5149

52-
The optimization process will fail if the necessary keys for the chosen model are not found in your environment.
53-
54-
3. **Log In to Weco (Optional):**
55-
56-
To associate your optimization runs with your Weco account and view them on the Weco dashboard, you can log in. `weco` uses a device authentication flow:
57-
58-
- When you first run `weco run`, you'll be prompted if you want to log in or proceed anonymously.
59-
- If you choose to log in (by pressing `l`), you'll be shown a URL and `weco` will attempt to open it in your default web browser.
60-
- You then authenticate in the browser. Once authenticated, the CLI will detect this and complete the login.
61-
- This saves a Weco-specific API key locally (typically at `~/.config/weco/credentials.json`).
62-
63-
If you choose to skip login (by pressing Enter or `s`), `weco` will still function using the environment variable LLM keys, but the run history will not be linked to a Weco account.
64-
65-
To log out and remove your saved Weco API key, use the `weco logout` command.
66-
6750
---
6851

69-
## Usage
70-
71-
The CLI has two main commands:
72-
73-
- `weco run`: Initiates the code optimization process.
74-
- `weco logout`: Logs you out of your Weco account.
52+
## Get Started
7553

7654
<div style="background-color: #fff3cd; border: 1px solid #ffeeba; padding: 15px; border-radius: 4px; margin-bottom: 15px;">
7755
<strong>⚠️ Warning: Code Modification</strong><br>
@@ -80,10 +58,6 @@ The CLI has two main commands:
8058

8159
---
8260

83-
### `weco run` Command
84-
85-
This command starts the optimization process.
86-
8761
**Example: Optimizing Simple PyTorch Operations**
8862

8963
This basic example shows how to optimize a simple PyTorch function for speedup.
@@ -126,13 +100,8 @@ weco run --source optimize.py \
126100
127101
---
128102
129-
### `weco logout` Command
130-
131-
This command logs you out by removing the locally stored Weco API key.
132-
133-
```bash
134-
weco logout
135-
```
103+
### Weco Dashboard
104+
To associate your optimization runs with your Weco account and view them on the Weco dashboard, you can log in. `weco` uses a device authentication flow
136105
137106
---
138107

0 commit comments

Comments
 (0)