Skip to content

Commit 6e0f05d

Browse files
authored
Merge pull request #978 from OpenAdaptAI/fix/simplify-readme
fix: Use filename-based GitHub Actions badge URL
2 parents fcef4c8 + 964a58b commit 6e0f05d

File tree

2 files changed

+11
-67
lines changed

2 files changed

+11
-67
lines changed

README.md

Lines changed: 2 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenAdapt: AI-First Process Automation with Large Multimodal Models (LMMs)
22

3-
[![Build Status](https://github.com/OpenAdaptAI/OpenAdapt/workflows/Python%20CI/badge.svg?branch=main)](https://github.com/OpenAdaptAI/OpenAdapt/actions)
3+
[![Build Status](https://github.com/OpenAdaptAI/OpenAdapt/actions/workflows/main.yml/badge.svg)](https://github.com/OpenAdaptAI/OpenAdapt/actions/workflows/main.yml)
44
[![PyPI version](https://img.shields.io/pypi/v/openadapt.svg)](https://pypi.org/project/openadapt/)
55
[![Downloads](https://img.shields.io/pypi/dm/openadapt.svg)](https://pypi.org/project/openadapt/)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -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

docs/design/production-execution-design.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This document addresses a critical gap in the OpenAdapt architecture: the **EXEC
2727

2828
---
2929

30-
## 1. Problem Statement
30+
## 1. Problem Statement {#1-problem-statement}
3131

3232
### Current Architecture
3333

@@ -56,7 +56,7 @@ RECORD (capture) --> TRAIN (ml) --> EXECUTE (evals)
5656

5757
---
5858

59-
## 2. Literature Review
59+
## 2. Literature Review {#2-literature-review}
6060

6161
### 2.1 Microsoft UFO (2024-2025)
6262

@@ -173,7 +173,7 @@ RECORD (capture) --> TRAIN (ml) --> EXECUTE (evals)
173173

174174
---
175175

176-
## 3. Gap Analysis
176+
## 3. Gap Analysis {#3-gap-analysis}
177177

178178
### 3.1 What OpenAdapt Has
179179

@@ -289,7 +289,7 @@ RECORD (capture) --> TRAIN (ml) --> EXECUTE (evals)
289289

290290
---
291291

292-
## 4. Architectural Options
292+
## 4. Architectural Options {#4-architectural-options}
293293

294294
### Option A: Rename/Expand openadapt-evals
295295

@@ -425,7 +425,7 @@ openadapt-evals
425425

426426
---
427427

428-
## 5. Recommendation
428+
## 5. Recommendation {#5-recommendation}
429429

430430
### Primary Recommendation: Option B (openadapt-agent)
431431

@@ -507,7 +507,7 @@ openadapt eval run --benchmark waa # Benchmarking (unchanged)
507507

508508
---
509509

510-
## 6. README Improvement Proposal
510+
## 6. README Improvement Proposal {#6-readme-improvement-proposal}
511511

512512
### Current Issues
513513

@@ -583,7 +583,7 @@ Production automation includes:
583583
584584
- [Documentation](https://docs.openadapt.ai)
585585
- [Discord](https://discord.gg/yF527cQbDG)
586-
- [Architecture](./docs/architecture-evolution.md)
586+
- [Architecture](../architecture-evolution.md)
587587
588588
## License
589589
@@ -601,7 +601,7 @@ MIT
601601

602602
---
603603

604-
## 7. Implementation Roadmap
604+
## 7. Implementation Roadmap {#7-implementation-roadmap}
605605

606606
### Q1 2026: Foundation
607607

@@ -639,7 +639,7 @@ MIT
639639

640640
---
641641

642-
## 8. References
642+
## 8. References {#8-references}
643643

644644
### GUI Automation Frameworks
645645

0 commit comments

Comments
 (0)