tjcaspar commited on
Commit
0ae446a
·
verified ·
1 Parent(s): fbd37d1

Simplify README

Browse files
Files changed (1) hide show
  1. README.md +23 -82
README.md CHANGED
@@ -20,82 +20,24 @@ configs:
20
 
21
  # GroundGUI_RL
22
 
23
- A 12,600-prompt reinforcement-learning corpus for desktop GUI grounding. Each
24
- prompt is a screenshot plus a natural-language instruction, and the reward is
25
- whether the predicted click falls inside the target element's bounding box.
 
26
 
27
- **All content comes from [GroundCUA](https://huggingface.co/datasets/ServiceNow/GroundCUA)**
28
- (MIT). The screenshots are byte-identical to GroundCUA's, and the instructions
29
- and boxes are GroundCUA's annotations. This release adds only sample
30
- selection, slice mixing and formatting into a Qwen3-VL `computer_use`
31
- tool-call prompt. Please cite GroundCUA (below) if you use it.
32
-
33
- | | |
34
- |---|---|
35
- | Prompts | 12,600 |
36
- | Screenshots | 11,205 (at most 2 prompts per image) |
37
- | Applications | 87 desktop apps (from GroundCUA) |
38
- | Size | ~4.9 GB (10 parquet shards, images embedded) |
39
-
40
- ## Layout
41
-
42
- ```
43
- GroundGUI_RL/
44
- ├── data/train-0000{0..9}-of-00010.parquet # 12,600 rows, screenshots embedded as image bytes
45
- ├── SHA256SUMS
46
- ├── LICENSE
47
- └── README.md
48
- ```
49
-
50
- ## Record format
51
-
52
- ```text
53
- {
54
- "images": [<PIL.Image 1920x1008>],
55
- "messages": [
56
- {"role": "system", "content": "<computer_use tool definition; screen given as 1000x1000>"},
57
- {"role": "user", "content": "<image>\nSelect a gradient to apply a smooth color transition ..."},
58
- {"role": "assistant", "content": "<tool_call>\n{\"name\": \"computer_use\", \"arguments\": {\"action\": \"left_click\", \"coordinate\": [96, 399]}}\n</tool_call>"}
59
- ],
60
- "solution": {"name": "mobile_use", "arguments": {"action": "click", "coordinate": [139, 381, 232, 426]}},
61
- "additional_paras": "{\"image_size\": [1920, 1008], \"app\": \"Krita\", \"ui_type\": \"icon\", ...}",
62
- "sample_id": 4026033
63
- }
64
- ```
65
-
66
- Coordinate conventions (note that the two fields use different units):
67
-
68
- - `solution.arguments.coordinate` is the target box `[x1, y1, x2, y2]` in
69
- **absolute pixels** of the original image. Reward functions should
70
- normalise it with `image_size`.
71
- - The assistant turn is a reference answer: the box centre in **0–1000
72
- normalised** coordinates (Qwen3-VL convention). It is useful for SFT
73
- warm-up. An RL reward should use `solution`.
74
- - `additional_paras` is a **JSON string**, not an object.
75
-
76
- `additional_paras` fields:
77
-
78
- | field | meaning |
79
- |---|---|
80
- | `image_size` | `[width, height]` in pixels (matches the PNG header for every row) |
81
- | `app` | GroundCUA application name |
82
- | `ui_type` | `icon` or `text` element |
83
- | `register` | `functional_instruction`, `spatial_relation` or `bare_label` |
84
- | `source` | which GroundCUA annotation file the instruction came from |
85
- | `elem_text` | GroundCUA element text of the target |
86
- | `area_frac` | target box area / image area |
87
- | `slice` | mixing slice (below) |
88
-
89
- ## Slices
90
 
91
  | slice | rows | content |
92
  |---|---:|---|
93
- | `base_icon_func` | 4,848 | GroundCUA functional instructions targeting icon elements |
94
- | `base_text_func` | 1,500 | GroundCUA functional instructions targeting text elements |
95
- | `icon_func_new` | 1,652 | additional functional instructions on icon elements |
96
- | `bare_label` | 2,000 | the element's own label as the instruction, e.g. "Wrap Text." (mostly text-labelled buttons) |
97
- | `spatial` | 2,000 | GroundCUA spatial-relation instructions, e.g. "... immediately right of \"app icon\"" (about 79% horizontal) |
98
- | `small` | 600 | small targets, 80–250 ppm of the image area |
99
 
100
  ## Usage
101
 
@@ -105,21 +47,20 @@ from datasets import load_dataset
105
 
106
  ds = load_dataset("tjcaspar/GroundGUI_RL", split="train")
107
  row = ds[0]
108
- img = row["images"][0] # PIL.Image
109
- extra = json.loads(row["additional_paras"]) # image_size, slice, ...
110
- x1, y1, x2, y2 = row["solution"]["arguments"]["coordinate"] # pixels
111
  ```
112
 
113
- ms-swift (GRPO / RLOO) can take the hub id directly:
114
-
115
- ```bash
116
- swift rlhf --rlhf_type grpo --dataset tjcaspar/GroundGUI_RL --reward_funcs <your-bbox-hit-reward> ...
117
- ```
118
 
119
- ## License and attribution
120
 
121
  MIT, inherited from GroundCUA (see `LICENSE`). Screenshots show third-party
122
- applications whose interfaces remain the property of their owners.
 
123
 
124
  ```bibtex
125
  @misc{feizi2025groundingcomputeruseagents,
 
20
 
21
  # GroundGUI_RL
22
 
23
+ A reinforcement-learning (RLOO) corpus for desktop GUI grounding: 12,600
24
+ prompts over 11,205 screenshots from 87 desktop applications. Each prompt is a
25
+ screenshot plus a natural-language instruction, and the reward is whether the
26
+ predicted click lands inside the target element's bounding box.
27
 
28
+ All screenshots, instructions and boxes come from
29
+ [GroundCUA](https://huggingface.co/datasets/ServiceNow/GroundCUA) (MIT). This
30
+ release only selects and mixes samples and formats them as Qwen3-VL
31
+ `computer_use` tool-call prompts.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
32
 
33
  | slice | rows | content |
34
  |---|---:|---|
35
+ | `base_icon_func` | 4,848 | functional instructions, icon targets |
36
+ | `base_text_func` | 1,500 | functional instructions, text targets |
37
+ | `icon_func_new` | 1,652 | more functional instructions, icon targets |
38
+ | `bare_label` | 2,000 | the element's label as the instruction, e.g. "Wrap Text." |
39
+ | `spatial` | 2,000 | spatial relations, e.g. "... immediately right of \"app icon\"" |
40
+ | `small` | 600 | small targets (80–250 ppm of the image area) |
41
 
42
  ## Usage
43
 
 
47
 
48
  ds = load_dataset("tjcaspar/GroundGUI_RL", split="train")
49
  row = ds[0]
50
+ img = row["images"][0] # PIL.Image
51
+ x1, y1, x2, y2 = row["solution"]["arguments"]["coordinate"] # target box, absolute pixels
52
+ extra = json.loads(row["additional_paras"]) # JSON string: image_size, app, slice, ...
53
  ```
54
 
55
+ `messages` holds the system, user and assistant turns. The assistant turn is
56
+ a reference answer: the box centre in 0–1000 normalised coordinates. Compute
57
+ the reward from `solution`.
 
 
58
 
59
+ ## License and citation
60
 
61
  MIT, inherited from GroundCUA (see `LICENSE`). Screenshots show third-party
62
+ applications whose interfaces remain the property of their owners. If you use
63
+ this data, please cite GroundCUA:
64
 
65
  ```bibtex
66
  @misc{feizi2025groundingcomputeruseagents,