CITTYJAMES commited on
Commit
89d3905
·
verified ·
1 Parent(s): 371b45d

Update README.md. Add schema and usage sections to dataset card.

Browse files

Fixed markdown formatting and added Intended Uses + Schema sections.

Files changed (1) hide show
  1. README.md +97 -6
README.md CHANGED
@@ -2,6 +2,19 @@
2
  language:
3
  - en
4
  pretty_name: Melbourne Cafés & Restaurants (OSM / Overpass)
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  ---
6
 
7
  ---
@@ -18,12 +31,28 @@ license: odbl-1.0
18
 
19
  ---
20
 
 
 
 
 
21
  ## Dataset Description
22
  An open dataset of cafés and restaurants in metropolitan Melbourne collected with the OpenStreetMap Overpass API.
23
  The table includes geospatial coordinates, address details, and engineered features for text and vector-search tasks.
24
 
25
  ---
26
 
 
 
 
 
 
 
 
 
 
 
 
 
27
  ## Collection Parameters
28
  - **Bounding box:** `south = -38.26`, `north = -37.47`, `west = 144.49`, `east = 145.49`
29
  - **Queries executed:**
@@ -41,8 +70,13 @@ The table includes geospatial coordinates, address details, and engineered featu
41
  relation["amenity"="cafe"](-38.26,144.49,-37.47,145.49);
42
  );
43
  out tags center;
 
 
 
44
 
45
- Data Cleaning & Augmentation
 
 
46
 
47
  After merging café and restaurant records:
48
 
@@ -64,8 +98,40 @@ boolean flags: has_wifi, has_outdoor, is_accessible (where inferable)
64
 
65
  Validation: simple checks for duplicates, coordinate ranges, and missing essentials.
66
 
 
67
 
68
- Reliability & Coverage
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
  Coverage bias: OSM completeness varies by suburb; some tags (e.g., cuisine, opening_hours) may be missing.
71
 
@@ -79,19 +145,31 @@ Task 2: Apply a pre-trained Transformer (zero-shot) to label text (e.g., fine di
79
 
80
  Task 3: Generate text embeddings and perform FAISS top-k similarity search.
81
 
82
- Licence & Attribution
 
 
 
 
83
 
84
  ODbL 1.0 — © OpenStreetMap contributors.
85
  Attribution and share-alike apply to adapted databases and redistributions.
86
  See: https://www.openstreetmap.org/copyright
87
 
88
- Ethics & Privacy (Australia)
 
 
 
 
89
 
90
  Dataset contains only business locations — no personal or sensitive information.
91
  Complies with APP 3 (collection), APP 5 (notification), and APP 8 (cross-border disclosure) under the Privacy Act 1988 (Cth).
92
  Hugging Face hosting occurs outside Australia; attribution, data retention, and provenance are documented in the course report.
93
 
94
- Storage & Versioning
 
 
 
 
95
 
96
  Earlier raw/intermediate files (osm_melb_cafes_raw.json, melbourne_cafes_restaurants.csv) were uploaded temporarily for validation and are now archived locally to keep the preview clean.
97
  Only the canonical file melbourne_cafes_restaurants_clean.csv remains at repo root.
@@ -101,7 +179,20 @@ Load
101
  from datasets import load_dataset
102
  ds = load_dataset("CITTYJAMES/melbourne-cafes-restaurants-osm")
103
 
104
- Citation
 
 
 
 
105
 
106
  Gaddi, Heidi (2025). Melbourne Cafés & Restaurants (OpenStreetMap / Overpass).
107
  Hugging Face Datasets. https://huggingface.co/datasets/CITTYJAMES/melbourne-cafes-restaurants-osm
 
 
 
 
 
 
 
 
 
 
2
  language:
3
  - en
4
  pretty_name: Melbourne Cafés & Restaurants (OSM / Overpass)
5
+ task_categories:
6
+ - text-classification
7
+ - feature-extraction
8
+ tags:
9
+ - openstreetmap
10
+ - geospatial
11
+ - hospitality
12
+ - melbourne
13
+ - australia
14
+ - poi
15
+ size_categories:
16
+ - 1K-10K
17
+ license: odbl
18
  ---
19
 
20
  ---
 
31
 
32
  ---
33
 
34
+ ---
35
+
36
+ A curated dataset of 1,896 cafés and restaurants in Melbourne, extracted from OpenStreetMap via the Overpass API and enriched with engineered features for geospatial analysis, zero‑shot classification, and embedding‑based similarity search.
37
+
38
  ## Dataset Description
39
  An open dataset of cafés and restaurants in metropolitan Melbourne collected with the OpenStreetMap Overpass API.
40
  The table includes geospatial coordinates, address details, and engineered features for text and vector-search tasks.
41
 
42
  ---
43
 
44
+ ---
45
+
46
+ ## Intended Uses
47
+
48
+ - **Task 1:** Exploratory and geospatial analysis of Melbourne’s café and restaurant landscape.
49
+ - **Task 2:** Zero-shot labeling with pre-trained transformers (e.g., “fine dining”, “family friendly”).
50
+ - **Task 3:** Text embedding generation and FAISS top‑k similarity search for recommendation or retrieval applications.
51
+
52
+ ---
53
+
54
+ ---
55
+
56
  ## Collection Parameters
57
  - **Bounding box:** `south = -38.26`, `north = -37.47`, `west = 144.49`, `east = 145.49`
58
  - **Queries executed:**
 
70
  relation["amenity"="cafe"](-38.26,144.49,-37.47,145.49);
71
  );
72
  out tags center;
73
+ ```
74
+
75
+ ---
76
 
77
+ ---
78
+
79
+ ## Data Cleaning & Augmentation
80
 
81
  After merging café and restaurant records:
82
 
 
98
 
99
  Validation: simple checks for duplicates, coordinate ranges, and missing essentials.
100
 
101
+ ---
102
 
103
+ ---
104
+
105
+ ## Schema
106
+
107
+ | Field | Type | Description |
108
+ |----------------------|-----------|-------------|
109
+ | name | string | Business name |
110
+ | lat, lon | float | Coordinates |
111
+ | address | string | Street address |
112
+ | cuisine_primary | string | Extracted primary cuisine type |
113
+ | has_wifi | boolean | Wi-Fi availability |
114
+ | is_accessible | boolean | Wheelchair accessibility |
115
+ | outdoor_seating | boolean | Outdoor seating availability |
116
+ | distance_to_cbd_km | float | Haversine distance to Melbourne CBD |
117
+ | desc | string | Human-readable summary |
118
+ | text | string | Concatenated text used for zero-shot and embeddings |
119
+
120
+ ---
121
+
122
+ ---
123
+
124
+ ## Example Use Cases
125
+ - Recommendation systems
126
+ - Accessibility-aware search
127
+ - RAG chatbot
128
+ - Market analysis
129
+
130
+ ---
131
+
132
+ ---
133
+
134
+ ## Reliability & Coverage
135
 
136
  Coverage bias: OSM completeness varies by suburb; some tags (e.g., cuisine, opening_hours) may be missing.
137
 
 
145
 
146
  Task 3: Generate text embeddings and perform FAISS top-k similarity search.
147
 
148
+ ---
149
+
150
+ ---
151
+
152
+ ## Licence & Attribution
153
 
154
  ODbL 1.0 — © OpenStreetMap contributors.
155
  Attribution and share-alike apply to adapted databases and redistributions.
156
  See: https://www.openstreetmap.org/copyright
157
 
158
+ ---
159
+
160
+ ---
161
+
162
+ ## Ethics & Privacy (Australia)
163
 
164
  Dataset contains only business locations — no personal or sensitive information.
165
  Complies with APP 3 (collection), APP 5 (notification), and APP 8 (cross-border disclosure) under the Privacy Act 1988 (Cth).
166
  Hugging Face hosting occurs outside Australia; attribution, data retention, and provenance are documented in the course report.
167
 
168
+ ---
169
+
170
+ ---
171
+
172
+ ## Storage & Versioning
173
 
174
  Earlier raw/intermediate files (osm_melb_cafes_raw.json, melbourne_cafes_restaurants.csv) were uploaded temporarily for validation and are now archived locally to keep the preview clean.
175
  Only the canonical file melbourne_cafes_restaurants_clean.csv remains at repo root.
 
179
  from datasets import load_dataset
180
  ds = load_dataset("CITTYJAMES/melbourne-cafes-restaurants-osm")
181
 
182
+ ---
183
+
184
+ ---
185
+
186
+ ## Citation
187
 
188
  Gaddi, Heidi (2025). Melbourne Cafés & Restaurants (OpenStreetMap / Overpass).
189
  Hugging Face Datasets. https://huggingface.co/datasets/CITTYJAMES/melbourne-cafes-restaurants-osm
190
+
191
+ ---
192
+
193
+ ---
194
+
195
+ ## Usage
196
+ ```python
197
+ from datasets import load_dataset
198
+ ds = load_dataset("CITTYJAMES/melbourne-cafes-restaurants-osm")