Update README.md
Browse files
README.md
CHANGED
@@ -12,4 +12,106 @@ tags:
|
|
12 |
pretty_name: CAGUI
|
13 |
size_categories:
|
14 |
- 1K<n<10K
|
15 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
pretty_name: CAGUI
|
13 |
size_categories:
|
14 |
- 1K<n<10K
|
15 |
+
---
|
16 |
+
|
17 |
+
|
18 |
+
# CAGUI: **C**hinese **A**ndroid **GUI** Benchmark
|
19 |
+
A real-world Chinese Android GUI benchmark designed to evaluate **GUI agent models** on two complementary capabilities:
|
20 |
+
|
21 |
+
* **Grounding** – understanding individual GUI components and linking them to semantics.
|
22 |
+
* **Agent** – planning and executing multi-step actions to complete user goals on Chinese Android apps.
|
23 |
+
|
24 |
+
---
|
25 |
+
|
26 |
+
## 🌟 Key Features
|
27 |
+
| Aspect | Grounding | Agent |
|
28 |
+
|--------|-----------|-------|
|
29 |
+
| **Objective** | Map bounding boxes ➜ function / OCR text | Follow natural-language instructions to operate an app |
|
30 |
+
| **Data** | 2 × JSONL files (`cap.jsonl`, `ocr.jsonl`) + screenshots | Per-episode JSON + step-level screenshots |
|
31 |
+
| **Actions** | _n/a_ | Tap, long-tap, text-input, scroll, etc. (`result_action_type`) |
|
32 |
+
|
33 |
+
---
|
34 |
+
|
35 |
+
## 🗂️ Repository Structure
|
36 |
+
```
|
37 |
+
|
38 |
+
CAGUI
|
39 |
+
├─ CAGUI\_agent
|
40 |
+
│ └─ domestic/
|
41 |
+
│ └─ \<episode\_id>/
|
42 |
+
│ ├─ \<episode\_id>.json # episode file
|
43 |
+
│ ├─ \<episode\_id>\_0.jpeg # step-0 screenshot
|
44 |
+
│ ├─ \<episode\_id>\_1.jpeg
|
45 |
+
│ └─ ...
|
46 |
+
└─ CAGUI\_grounding
|
47 |
+
├─ code/
|
48 |
+
│ ├─ cap.jsonl # bbox ➜ function
|
49 |
+
│ └─ ocr.jsonl # bbox ➜ OCR text
|
50 |
+
└─ images/
|
51 |
+
├─ cap/
|
52 |
+
│ └─ 0.jpeg
|
53 |
+
└─ ocr/
|
54 |
+
└─ 0.jpeg
|
55 |
+
|
56 |
+
````
|
57 |
+
|
58 |
+
---
|
59 |
+
|
60 |
+
## 📑 Data Format
|
61 |
+
|
62 |
+
### 1. Agent episodes (`CAGUI_agent/domestic/<episode_id>/<episode_id>.json`)
|
63 |
+
Each file is a **list of steps**:
|
64 |
+
|
65 |
+
| Field | Type | Description |
|
66 |
+
|-------|------|-------------|
|
67 |
+
| `episode_id` | str | Unique id |
|
68 |
+
| `episode_length` | int | Total steps |
|
69 |
+
| `step_id` | int | Step index (0-based) |
|
70 |
+
| `instruction` | str | user goal |
|
71 |
+
| `image_path` | str | Relative path to screenshot |
|
72 |
+
| `image_width` / `image_height` | int | Raw resolution |
|
73 |
+
| `ui_positions` | str (JSON list) | Normalised \[[y, x, h, w], …] UI element boxes |
|
74 |
+
| `result_action_type` | int | Action code |
|
75 |
+
| `result_action_text` | str | Text typed (if any) |
|
76 |
+
| `result_touch_yx` / `result_lift_yx` | str | Normalised touch coords, `[-1,-1]` if no touch |
|
77 |
+
| `duration` | float \| null | Action time (s) |
|
78 |
+
|
79 |
+
### 2. Grounding annotations (`cap.jsonl`, `ocr.jsonl`)
|
80 |
+
One JSON object per line:
|
81 |
+
|
82 |
+
| Field | Example | Description |
|
83 |
+
|-------|---------|-------------|
|
84 |
+
| `task` | `"bbox2function"` / `"bbox2text"` | Sub-task type |
|
85 |
+
| `image` | `"grounding_eval/dataset/images/0.jpeg"` | Screenshot path |
|
86 |
+
| `id` | `0` | Unique int id |
|
87 |
+
| `abs_position` | `"<x1, y1, x2, y2>"` | Pixel-level bbox |
|
88 |
+
| `rel_position` | `"<x1, y1, x2, y2>"` | Normalised bbox |
|
89 |
+
| `text` | `"UI元素是一个菜单按钮…"` | Target description / OCR string |
|
90 |
+
|
91 |
+
|
92 |
+
---
|
93 |
+
|
94 |
+
## 📜 License
|
95 |
+
|
96 |
+
CAGUI is released under the **CC-BY-NC 4.0** license for **non-commercial research**.
|
97 |
+
Screenshots originate from publicly available Chinese apps and are used under fair-use for research purposes only. Remove them if local regulations require.
|
98 |
+
|
99 |
+
---
|
100 |
+
|
101 |
+
## ✏️ Citation
|
102 |
+
|
103 |
+
This benchmark is used for evaluating [AgentCPM-GUI](https://github.com/OpenBMB/AgentCPM-GUI). If our model and benchmark are useful for your research, please cite:
|
104 |
+
|
105 |
+
```bibtex
|
106 |
+
@misc{2025,
|
107 |
+
author = {THUNLP},
|
108 |
+
title = {AgentCPM-GUI},
|
109 |
+
year = {2025},
|
110 |
+
publisher = {GitHub},
|
111 |
+
journal = {GitHub repository},
|
112 |
+
howpublished = {\url{https://github.com/OpenBMB/AgentCPM-GUI}}
|
113 |
+
}
|
114 |
+
```
|
115 |
+
|
116 |
+
---
|
117 |
+
|