Skip to content

Commit 121d663

Browse files
authored
Clean up README to make it more copy-pastable, with simplifying the sample command and making the parallelism between AIS and Vertex clearer. (#40)
1 parent c069d61 commit 121d663

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ playwright install chrome
3232
```
3333

3434
### 2. Configuration
35+
You can get started using either the Gemini Developer API or Vertex AI.
3536

36-
#### Set Gemini API Key (for Gemini Developer API only)
37+
#### A. If using the Gemini Developer API:
3738

3839
You need a Gemini API key to use the agent:
3940

@@ -53,7 +54,7 @@ source .venv/bin/activate
5354

5455
Replace `YOUR_GEMINI_API_KEY` with your actual key.
5556

56-
#### Setup Vertex AI Client (for Vertex AI API only)
57+
#### B. If using the Vertex AI Client:
5758

5859
You need to explicitly use Vertex AI, then provide project and location to use the agent:
5960

@@ -84,11 +85,13 @@ The primary way to use the tool is via the `main.py` script.
8485
**General Command Structure:**
8586

8687
```bash
87-
python main.py --query "Go to Google and type 'Hello World' into the search bar" --env <environment> [options]
88+
python main.py --query "Go to Google and type 'Hello World' into the search bar"
8889
```
8990

9091
**Available Environments:**
9192

93+
You can specify a particular environment with the ```--env <environment>``` flag. Available options:
94+
9295
- `playwright`: Runs the browser locally using Playwright.
9396
- `browserbase`: Connects to a Browserbase instance.
9497
- `hud`: Integrates with hud's browser environment.
@@ -167,4 +170,4 @@ python hud_eval.py --taskset SheetBench-V2
167170

168171
# Run in parallel with 50 concurrent tasks (can support up to 400)
169172
python hud_eval.py --taskset OSWorld-Verified --parallel --max_concurrent 50
170-
```
173+
```

0 commit comments

Comments
 (0)