feiziaarash commited on
Commit
68ff64a
Β·
verified Β·
1 Parent(s): 8469cd0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +116 -46
README.md CHANGED
@@ -1,82 +1,152 @@
1
  ---
2
  language:
3
- - en
4
  tags:
5
- - computer_use
6
- - agents
7
- - grounding
8
- - multimodal
9
- - ui-vision
10
- - GroundCUA
11
  size_categories:
12
- - 10K<n<100K
 
 
 
13
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  # GroundCUA Dataset
15
 
16
- ## Overview
 
 
 
 
 
 
 
 
 
 
17
 
18
- GroundCUA is a comprehensive dataset containing annotated UI screenshots and corresponding ground truth data for building computer use agents. The dataset covers 87 different software platforms/applications, providing rich annotations for UI element detection, classification, and understanding.
19
 
20
  ## Dataset Structure
21
 
22
  ```
23
  GroundCUA/
24
- β”œβ”€β”€ data/ # Annotation files (JSON format)
25
- β”œβ”€β”€ images/ # Screenshot images (PNG format)
26
- β”œβ”€β”€ README.md
27
  ```
28
 
29
- ### Directory Organization
 
 
 
 
 
 
 
30
 
31
- - **`data/`**: Contains 87 platform-specific directories, each with JSON annotation files
32
- - **`images/`**: Contains 87 platform-specific directories, each with corresponding PNG screenshot images
33
 
34
  ## File Naming Convention
35
 
36
- Files are named using SHA-256 hashes, ensuring unique identifiers while maintaining correspondence between annotation and image files:
37
- - `data/Platform/[hash].json`
38
- - `images/Platform/[hash].png`
 
39
 
40
- Where `[hash]` is the same SHA-256 hash for corresponding annotation and image pairs.
 
 
 
 
 
 
41
 
42
  ## Annotation Format
43
 
44
- Each JSON file contains an array of UI element annotations with the following structure:
45
 
46
  ```json
47
  [
48
- {
49
- "image_path": "Platform/screenshot_hash.png",
50
- "bbox": [x1, y1, x2, y2],
51
- "text": "UI element text",
52
- "category": "Element category",
53
- "id": "unique-identifier"
54
- },
55
- ...
56
  ]
57
  ```
58
 
59
- ### Annotation Fields
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
 
61
- - **`image_path`**: Relative path to the corresponding screenshot image
62
- - **`bbox`**: Bounding box coordinates [x1, y1, x2, y2] defining the element's location
63
- - **`text`**: Text content or description of the UI element
64
- - **`category`**: Classification of the UI element type. This is a crude classification and is present for few elements
65
- - **`id`**: Unique identifier for the annotation
66
 
67
- ### UI Element Categories
68
 
69
- The dataset includes several categories of UI elements (these are not avaialble for the entire dataset and maybe ambiguious sometimes):
 
 
 
 
 
 
 
70
 
71
- - **`Button`**: Interactive buttons and clickable elements
72
- - **`Menu`**: Interactive buttons and clickable elements
73
- - **`Input Elements`**: Text fields, dropdowns, checkboxes, and other input controls
74
- - **`Navigation`**: Menu items, navigation bars, and navigational elements
75
- - **`Sidebar`**: Sidebars like scrollbars
76
- - **`Visual Elements`**: Labels, headers, icons, and visual display components
77
- - **`Information Display`**: Status bars, information panels, and data display elements
78
- - **`Others`**: Miscellaneous UI elements that don't fit other categories
 
 
 
 
 
 
 
79
 
80
  ## License
81
 
82
- This dataset is released under the MIT License. See the license header for details.
 
 
1
  ---
2
  language:
3
+ - en
4
  tags:
5
+ - computer_use
6
+ - agents
7
+ - grounding
8
+ - multimodal
9
+ - ui-vision
10
+ - GroundCUA
11
  size_categories:
12
+ - 10K<n<100K
13
+ license: mit
14
+ task_categories:
15
+ - image-text-to-text
16
  ---
17
+
18
+ <p align="center">
19
+ <img src="assets/logo.png" width="48" alt="GroundCUA Logo" style="vertical-align:middle;margin-right:6px;">
20
+ <strong>GroundCUA: Grounding Computer Use Agents on Human Demonstrations</strong>
21
+ </p>
22
+
23
+ <p align="center">
24
+ 🌐 <a href="https://groundcua.github.io">Website</a> |
25
+ πŸ“‘ <a href="https://arxiv.org/abs/2511.07332">Paper</a> |
26
+ πŸ€— <a href="https://huggingface.co/datasets/ServiceNow/GroundCUA">Dataset</a> |
27
+ πŸ€– <a href="https://huggingface.co/ServiceNow/GroundNext-7B-V0">Models</a>
28
+ </p>
29
+
30
+ <p align="center">
31
+ <img src="assets/groundcua-hq.png" width="100%" alt="GroundCUA Overview">
32
+ </p>
33
+
34
  # GroundCUA Dataset
35
 
36
+ GroundCUA is a large and diverse dataset of real UI screenshots paired with structured annotations for building multimodal computer use agents. It covers **87 software platforms** across productivity tools, browsers, creative tools, communication apps, development environments, and system utilities. GroundCUA is designed for research on GUI grounding, UI perception, and vision-language-action models that interact with computers.
37
+
38
+ ---
39
+
40
+ ## Highlights
41
+
42
+ - **87 platforms** spanning Windows, macOS, Linux, and cross-platform apps
43
+ - **Annotated UI elements** with bounding boxes, text, and coarse semantic categories
44
+ - **SHA-256 file pairing** between screenshots and JSON annotations
45
+ - **Supports research on GUI grounding, multimodal agents, and UI understanding**
46
+ - **MIT license** for broad academic and open source use
47
 
48
+ ---
49
 
50
  ## Dataset Structure
51
 
52
  ```
53
  GroundCUA/
54
+ β”œβ”€β”€ data/ # JSON annotation files
55
+ β”œβ”€β”€ images/ # Screenshot images
56
+ └── README.md
57
  ```
58
 
59
+ ### Directory Layout
60
+
61
+ Each platform appears as a directory name inside both `data/` and `images/`.
62
+
63
+ - `data/PlatformName/` contains annotation JSON files
64
+ - `images/PlatformName/` contains corresponding PNG screenshots
65
+
66
+ Image and annotation files share the same SHA-256 hash.
67
 
68
+ ---
 
69
 
70
  ## File Naming Convention
71
 
72
+ Each screenshot has a matching annotation file using the same hash:
73
+
74
+ - `data/PlatformName/[hash].json`
75
+ - `images/PlatformName/[hash].png`
76
 
77
+ This structure ensures:
78
+
79
+ - Unique identifiers for each screenshot
80
+ - Easy pairing between images and annotations
81
+ - Compatibility with pipelines that expect hash-based addressing
82
+
83
+ ---
84
 
85
  ## Annotation Format
86
 
87
+ Each annotation file is a list of UI element entries describing visible elements in the screenshot.
88
 
89
  ```json
90
  [
91
+ {
92
+ "image_path": "PlatformName/screenshot_hash.png",
93
+ "bbox": [x1, y1, x2, y2],
94
+ "text": "UI element text",
95
+ "category": "Element category",
96
+ "id": "unique-id"
97
+ }
 
98
  ]
99
  ```
100
 
101
+ ### Field Descriptions
102
+
103
+ **image_path**
104
+ Relative path to the screenshot.
105
+
106
+ **bbox**
107
+ Bounding box coordinates `[x1, y1, x2, y2]` in pixel space.
108
+
109
+ **text**
110
+ Visible text or a short description of the element.
111
+
112
+ **category**
113
+ Coarse UI type label. Present only for some elements.
114
+
115
+ **id**
116
+ Unique identifier for the annotation entry.
117
+
118
+ ---
119
 
120
+ ## UI Element Categories
 
 
 
 
121
 
122
+ Categories are approximate and not guaranteed for all elements. Examples include:
123
 
124
+ - **Button**
125
+ - **Menu**
126
+ - **Input Elements**
127
+ - **Navigation**
128
+ - **Sidebar**
129
+ - **Visual Elements**
130
+ - **Information Display**
131
+ - **Others**
132
 
133
+ These labels provide light structure for UI grounding tasks but do not form a full ontology.
134
+
135
+ ---
136
+
137
+ ## Example Use Cases
138
+
139
+ GroundCUA can be used for:
140
+
141
+ - Training computer use agents to perceive and understand UI layouts
142
+ - Building GUI grounding modules for VLA agents
143
+ - Pretraining screen parsing and UI element detectors
144
+ - Benchmarking OCR, layout analysis, and cross-platform UI parsing
145
+ - Developing models that map UI regions to natural language or actions
146
+
147
+ ---
148
 
149
  ## License
150
 
151
+ GroundCUA is released under the MIT License.
152
+ Users are responsible for ensuring compliance with all applicable laws and policies.