Skip to content

Commit 5e04c02

Browse files
abrichrclaude
andcommitted
docs: fix badge URL and simplify README
- Fix Build Status badge to use correct workflow path - Remove "(Aligned with GUI Agent Literature)" from Terminology header - Remove redundant "Meta-Package Structure" section (covered in Architecture) - Remove redundant "Installation Paths" section (covered in Installation) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 1d3efaf commit 5e04c02

File tree

1 file changed

+1
-57
lines changed

1 file changed

+1
-57
lines changed

README.md

Lines changed: 1 addition & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ OpenAdapt's key differentiator is **demonstration-conditioned automation** - "sh
309309

310310
---
311311

312-
## Terminology (Aligned with GUI Agent Literature)
312+
## Terminology
313313

314314
| Term | Description |
315315
|------|-------------|
@@ -320,62 +320,6 @@ OpenAdapt's key differentiator is **demonstration-conditioned automation** - "sh
320320
| **Policy** | Decision-making component that maps observations to actions |
321321
| **Grounding** | Mapping intent to specific UI elements (coordinates) |
322322

323-
## Meta-Package Structure
324-
325-
OpenAdapt v1.0+ uses a **modular architecture** where the main `openadapt` package acts as a meta-package that coordinates focused sub-packages:
326-
327-
- **Core Packages**: Essential for the three-phase pipeline
328-
- `openadapt-capture` - DEMONSTRATE phase: Collects observations and actions
329-
- `openadapt-ml` - LEARN phase: Trains policies from demonstrations
330-
- `openadapt-evals` - EXECUTE phase: Evaluates agents on benchmarks
331-
332-
- **Optional Packages**: Enhance specific workflow phases
333-
- `openadapt-privacy` - DEMONSTRATE: PII/PHI scrubbing before storage
334-
- `openadapt-retrieval` - LEARN + EXECUTE: Demo conditioning for both training and evaluation
335-
- `openadapt-grounding` - EXECUTE: UI element localization (SoM, OmniParser)
336-
337-
- **Cross-Cutting**:
338-
- `openadapt-viewer` - Trajectory visualization at any phase
339-
340-
### Two Paths to Automation
341-
342-
1. **Custom Training Path**: Demonstrate -> Train policy -> Deploy agent
343-
- Best for: Repetitive tasks specific to your workflow
344-
- Requires: `openadapt[core]`
345-
346-
2. **API Agent Path**: Use pre-trained VLM APIs (Claude, GPT-4V, etc.) with demo conditioning
347-
- Best for: General-purpose automation, rapid prototyping
348-
- Requires: `openadapt[evals]`
349-
350-
---
351-
352-
## Installation Paths
353-
354-
Choose your installation based on your use case:
355-
356-
```
357-
What do you want to do?
358-
|
359-
+-- Just evaluate API agents on benchmarks?
360-
| +-- pip install openadapt[evals]
361-
|
362-
+-- Train custom models on your demonstrations?
363-
| +-- pip install openadapt[core]
364-
|
365-
+-- Full suite with all optional packages?
366-
| +-- pip install openadapt[all]
367-
|
368-
+-- Minimal CLI only (add packages later)?
369-
+-- pip install openadapt
370-
```
371-
372-
| Installation | Included Packages | Use Case |
373-
|-------------|-------------------|----------|
374-
| `openadapt` | CLI only | Start minimal, add what you need |
375-
| `openadapt[evals]` | + evals | Benchmark API agents (Claude, GPT-4V) |
376-
| `openadapt[core]` | + capture, ml, viewer | Full training workflow |
377-
| `openadapt[all]` | + privacy, retrieval, grounding | Everything including optional enhancements |
378-
379323
---
380324

381325
## Demos

0 commit comments

Comments
 (0)