jometeorie commited on
Commit
8242926
·
verified ·
1 Parent(s): 6fe5502

Add UrbanGround dataset card and license

Browse files
Files changed (2) hide show
  1. LICENSE +21 -0
  2. README.md +197 -0
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2026 UrbanGround Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md ADDED
@@ -0,0 +1,197 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: UrbanGround Tasks
3
+ license: mit
4
+ language:
5
+ - en
6
+ task_categories:
7
+ - visual-question-answering
8
+ - reinforcement-learning
9
+ - robotics
10
+ tags:
11
+ - embodied-ai
12
+ - multimodal
13
+ - spatial-reasoning
14
+ - navigation
15
+ - agent-evaluation
16
+ - 3d-city
17
+ - hong-kong
18
+ - arxiv:2608.27456
19
+ size_categories:
20
+ - n<1K
21
+ configs:
22
+ - config_name: default
23
+ data_files:
24
+ - split: test
25
+ path: data/benchmark.jsonl
26
+ - split: auxiliary
27
+ path: data/auxiliary_variants.jsonl
28
+ default: true
29
+ ---
30
+
31
+ # UrbanGround Tasks
32
+
33
+ UrbanGround Tasks is the evaluation dataset for [UrbanGround: From Local Perception to Spatial Agency in a Real-Scale City](https://huggingface.co/papers/2608.27456). It contains georegistered task definitions for evaluating multimodal agents in the UrbanGround real-scale 3D replica of Hong Kong.
34
+
35
+ - Paper: [arXiv:2608.27456](https://arxiv.org/abs/2608.27456)
36
+ - Code and desktop applications: [UrbanGround/UrbanGround](https://github.com/UrbanGround/UrbanGround)
37
+ - Interactive project page: [urbanground.github.io](https://urbanground.github.io/)
38
+
39
+ ## Quick start
40
+
41
+ ```python
42
+ from datasets import load_dataset
43
+
44
+ benchmark = load_dataset(
45
+ "jometeorie/urbanground-tasks",
46
+ split="test",
47
+ ) # 810 paper benchmark instances
48
+
49
+ print(benchmark[0])
50
+ ```
51
+
52
+ To also inspect the 28 non-benchmark legacy variants, load the complete
53
+ `DatasetDict` and use its `auxiliary` split:
54
+
55
+ ```python
56
+ dataset = load_dataset("jometeorie/urbanground-tasks")
57
+ auxiliary = dataset["auxiliary"]
58
+ ```
59
+
60
+ The `test` split is the complete evaluation benchmark. It is not intended as a
61
+ training/test partition. Reference answers and evaluator-only fields are
62
+ intentionally public for reproducible evaluation; leaderboard runs must control
63
+ which fields are exposed to the evaluated agent.
64
+
65
+ ## Why 700 stored tasks become 810 benchmark instances
66
+
67
+ The released application stores **700 unique benchmark source definitions** as JSON files. Level 5 changes the execution conditions of already validated navigation tasks instead of duplicating their geometry:
68
+
69
+ - 30 Constrained Navigation instances are reused for Dynamic Road-Closure Replanning.
70
+ - 80 Long-Range Goal Navigation instances are reused for Navigation among Pedestrians.
71
+
72
+ This produces the **810 benchmark instances reported in the paper**. The `test` split materializes those 110 Level 5 views as self-contained rows and records their origin in `source_task_id`, `is_derived`, and `derivation`.
73
+
74
+ The application package also contains 28 legacy environment and diagnostic
75
+ variants. They retain their original `variant_prefix` and `source_task_id`, but
76
+ the current application does not define a stable public condition schema for
77
+ those prefixes. They are therefore kept in the separate `auxiliary` split and
78
+ excluded from all benchmark totals.
79
+
80
+ ## Benchmark composition
81
+
82
+ | Level | Capability | Subtask | Abbr. | Instances |
83
+ |---:|---|---|:---:|---:|
84
+ | 1 | Local Environment Understanding | Visual Recognition | VR | 80 |
85
+ | 1 | Local Environment Understanding | Orientation Understanding | OU | 60 |
86
+ | 1 | Local Environment Understanding | Active Exploration Questions | AEQ | 80 |
87
+ | 2 | Navigation under Explicit Instructions | Short-Range Goal Navigation | SGN | 80 |
88
+ | 2 | Navigation under Explicit Instructions | Long-Range Goal Navigation | LGN | 80 |
89
+ | 2 | Navigation under Explicit Instructions | Instructional Navigation | IN | 50 |
90
+ | 2 | Navigation under Explicit Instructions | Constrained Navigation | CN | 30 |
91
+ | 3 | Exploration under Implicit Instructions | Place-Type Search | PTS | 60 |
92
+ | 3 | Exploration under Implicit Instructions | Implicit Intent Inference | III | 60 |
93
+ | 4 | Multi-Task Planning | Time-Window Scheduling | TWS | 60 |
94
+ | 4 | Multi-Task Planning | Multi-Stop Route Planning | MSP | 60 |
95
+ | 5 | Dynamic Environment Interaction | Dynamic Road-Closure Replanning | DCR | 30 |
96
+ | 5 | Dynamic Environment Interaction | Navigation among Pedestrians | NP | 80 |
97
+ | | | **Total** | | **810** |
98
+
99
+ ## Data organization
100
+
101
+ ```text
102
+ data/
103
+ ├── benchmark.jsonl # 810 rows used by the paper
104
+ └── auxiliary_variants.jsonl # 28 non-benchmark variants
105
+ metadata/
106
+ └── statistics.json # machine-readable counts
107
+ raw/
108
+ ├── urbanground-app-task-files-v1.0.0.zip
109
+ ├── task-files.sha256
110
+ └── manifest.json
111
+ scripts/
112
+ └── build_dataset.py
113
+ ```
114
+
115
+ The raw ZIP preserves the application's original one-file-per-task representation (`{"task": {...}}`) for direct placement beside a desktop build. The JSONL files flatten that wrapper, use `snake_case` field names, and add human-readable benchmark metadata for the Dataset Viewer.
116
+
117
+ ## Important fields
118
+
119
+ | Field | Description |
120
+ |---|---|
121
+ | `id` | Stable task instance identifier. |
122
+ | `task_type_id` | Integer task type used by the UrbanGround application. |
123
+ | `task_type`, `task_abbreviation` | Human-readable subtask name and paper abbreviation. |
124
+ | `capability_level`, `capability_name` | Level 1–5 and its capability group. |
125
+ | `release_role` | `stored_base`, `derived_level_5`, or `auxiliary_variant`. |
126
+ | `is_derived`, `derivation` | Materialized Level-5 provenance. |
127
+ | `source_task_id`, `variant_prefix` | Referenced stored task and retained legacy variant code, when applicable. |
128
+ | `start_point`, `end_point`, `qa_start_point`, etc. | WGS84 positions; `height` is in meters and `yaw` is in degrees. |
129
+ | `qa_options`, `qa_answer_index`, `qa_answer_text` | Multiple-choice candidates and the reference answer. |
130
+ | `restricted_zones` | Closed-road geometry for constrained and dynamic replanning. |
131
+ | `schedule`, `multi_route_targets` | Ordered or unordered multi-destination task definitions. |
132
+ | `notes` | Annotator-only notes; these must not be sent to the evaluated agent. |
133
+
134
+ Coordinates and reference fields are evaluator state, not a model-visible observation. In particular, `qa_answer_index`, `qa_answer_text`, `explore_answer`, and the reference `end_point` of implicit-intent tasks can leak the answer if passed to an evaluated model.
135
+
136
+ ## Evaluation protocol and answer visibility
137
+
138
+ This is an openly released benchmark, so the Dataset Viewer and downloaded
139
+ files include reference answers and evaluator geometry. The benchmark is not a
140
+ hidden-label test set. Evaluation must construct the model-visible prompt from
141
+ the task type and the live UrbanGround observation instead of passing an entire
142
+ row to the agent.
143
+
144
+ A conservative default allowlist is `id`, `task_type`, `task_abbreviation`,
145
+ `capability_level`, and `description`. Task-specific controller code may also
146
+ consume the appropriate start state or instruction parameters, but must keep
147
+ answer fields, reference goals, route targets, restricted-zone geometry, and
148
+ annotator metadata on the evaluator side. See the UrbanGround evaluation code
149
+ for the authoritative per-task protocol.
150
+
151
+ ## Using the data with UrbanGround
152
+
153
+ The dataset contains task definitions, not rendered observations or trajectories. Running an episode requires an UrbanGround desktop build or the browser application. Extract `raw/urbanground-app-task-files-v1.0.0.zip` so that its `task/` directory sits beside the desktop application, or use the task files already included in an official release archive. The archive contains the 728 stored App files; the application and normalized `test` split materialize the 110 Level-5 condition views from their source tasks at runtime.
154
+
155
+ The Hong Kong 3D Visualisation Map, 3D Pedestrian Network, Unity runtime, Cesium, and Microsoft Rocketbox assets are **not** redistributed in this dataset. Those components remain subject to their respective upstream terms.
156
+
157
+ ## Data considerations
158
+
159
+ - Task coordinates refer to public locations in Hong Kong and use WGS84 longitude/latitude.
160
+ - Some questions reproduce public-facing business names, signs, addresses, or telephone numbers visible in the city data.
161
+ - Descriptions involving people or households are task scenarios; the dataset does not contain records about evaluation participants.
162
+ - The dataset does not contain participant trajectories, account credentials, API keys, private user data, 3D Tiles, screenshots, or application binaries.
163
+ - Geographic content can become outdated as streets, businesses, and access conditions change.
164
+ - Successful use depends on the matching UrbanGround application and external map services.
165
+
166
+ ## License
167
+
168
+ The original task annotations, schema, and dataset packaging are released under
169
+ the [MIT License](LICENSE), matching the UrbanGround project. External map and
170
+ runtime components are not included and are not covered by this license. Public
171
+ geographic and storefront facts reproduced in individual tasks remain subject
172
+ to any applicable source terms.
173
+
174
+ ## Rebuilding the normalized files
175
+
176
+ From the UrbanGround source checkout, run:
177
+
178
+ ```bash
179
+ python HuggingFaceDataset/urbanground-tasks/scripts/build_dataset.py \
180
+ --source task \
181
+ --output HuggingFaceDataset/urbanground-tasks
182
+ ```
183
+
184
+ The script validates the expected subtask counts, materializes the Level-5
185
+ views, writes both JSONL splits, creates a deterministic App-compatible ZIP,
186
+ and regenerates its SHA-256 manifest.
187
+
188
+ ## Citation
189
+
190
+ ```bibtex
191
+ @article{ju2026urbanground,
192
+ title = {UrbanGround: From Local Perception to Spatial Agency in a Real-Scale City},
193
+ author = {Ju, Tianjie and Wu, Zheng and Sun, Yueqing and Cui, Yuhan and Li, Bobo and Wu, Shengqiong and Cheng, Pengzhou and Zhao, Haodong and Wu, Zongru and Ma, Xinbei and Zhang, Doris and Li, Kunling and Lee, Mong-Li and Hsu, Wynne and Fei, Hao and Gu, Qi and Liu, Gongshen and Zhang, Zhuosheng},
194
+ journal = {arXiv preprint arXiv:2608.27456},
195
+ year = {2026}
196
+ }
197
+ ```