Update README.md

README.md

@@ -1,44 +1,112 @@
----
-license: cc-by-sa-4.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
-dataset_info:
-  features:
-  - name: image
-    dtype: image
-  - name: label
-    dtype:
-      class_label:
-        names:
-          '0': calgary
-          '1': charlottetown
-          '2': edmonton
-          '3': halifax
-          '4': hamilton
-          '5': kitchener-waterloo
-          '6': montreal
-          '7': ottawa-gatineau
-          '8': quebec_city
-          '9': saskatoon
-          '10': st_johns
-          '11': toronto
-          '12': vancouver
-          '13': victoria
-          '14': winnipeg
-  - name: city
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 13205290442
-    num_examples: 135000
-  - name: test
-    num_bytes: 1451524680
-    num_examples: 15000
-  download_size: 14481675797
-  dataset_size: 14656815122
----
+---
+license: cc-by-sa-4.0
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+  - split: test
+    path: data/test-*
+dataset_info:
+  features:
+  - name: image
+    dtype: image
+  - name: label
+    dtype:
+      class_label:
+        names:
+          '0': calgary
+          '1': charlottetown
+          '2': edmonton
+          '3': halifax
+          '4': hamilton
+          '5': kitchener-waterloo
+          '6': montreal
+          '7': ottawa-gatineau
+          '8': quebec_city
+          '9': saskatoon
+          '10': st_johns
+          '11': toronto
+          '12': vancouver
+          '13': victoria
+          '14': winnipeg
+  - name: city
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 13205290442
+    num_examples: 135000
+  - name: test
+    num_bytes: 1451524680
+    num_examples: 15000
+  download_size: 14481675797
+  dataset_size: 14656815122
+language:
+- en
+tags:
+- geography
+- canada
+- cities
+pretty_name: Canadian Streetview Cities
+size_categories:
+- 100K<n<1M
+task_categories:
+- image-classification
+---
+
+# Canadian Street View Cities Dataset
+
+## Overview
+A street-view image dataset created to train and evaluate models for **city-level image classification** across major Canadian cities. Each entry includes an image and its corresponding city label.
+
+## Purpose
+The dataset is intended for building models that recognize the Canadian city in which a street-view scene was captured.
+
+## Data Source
+All images were collected from **Mapillary**, using geographic bounding boxes for each target city.  
+Collection was performed individually, collecting 10 000 images for each city.
+
+## Dataset Structure
+- **Train split:** 135,000 images  
+- **Test split:** 15,000 images  
+- Data is stored in **Parquet** files  
+- Includes **15 Canadian cities**, represented in the `label` and `city` fields
+
+## Features
+- **image** — street-view image  
+- **label** — integer class ID (0–14)  
+- **city** — text name of the city
+
+## Preprocessing
+No preprocessing was applied. Images are provided exactly as downloaded from Mapillary.
+
+## Known Limitations
+- Some cities, especially **Saskatoon** and **Halifax**, contain dashcam-style captures including visible dashboards.  
+  These can influence model behavior if not processed correctly or accounted for.
+
+## Example Usage
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("canada-guesser/Canadian-streetview-cities", streaming=False)
+train_ds = dataset["train"]
+test_ds = dataset["test"]
+```
+
+## Authors
+
+[Stephen](https://huggingface.co/SABR22)
+
+[Danial](https://huggingface.co/daniemc22)
+
+[Sharav](https://huggingface.co/sharavbali)
+
+## Project Implementation
+See our main project page at [Canada Guesser](https://huggingface.co/canada-guesser) for implementation details.
+
+
+## Citation
+
+If you use this dataset or models, please cite:
+
+1. Stephen Rebel, Danial McIntyre, Sharav Bali. *Canadian Street View Classifier*. Hugging Face, 2025.