Update README.md

README.md

@@ -13,4 +13,69 @@ tags:
 pretty_name: Quebec Traffic Signs
 size_categories:
 - 1K<n<10K
----
+---
+
+# Quebec Traffic Signs Dataset
+
+## Dataset Description
+
+The **Quebec Traffic Signs Dataset** is a specialized image dataset designed for the recognition and interpretation of road and traffic signs specific to the province of Quebec, Canada. This dataset aims to provide a comprehensive collection of signs, including regulatory, warning, and informational signs, with a particular focus on the unique bilingual (French/English) and complex parking/construction signage prevalent in Quebec, especially in urban areas like Montreal.
+
+This dataset is being developed to support the creation of intelligent mobile applications that can assist drivers in understanding local traffic regulations, particularly for parking restrictions and construction zone alerts, which are often a source of confusion.
+
+## Dataset Structure
+
+The dataset is organized as follows:
+
+```
+quebec-traffic-signs/
+├── images/
+│   ├── P-010-fr.png
+│   ├── P-010-en.png
+│   └── ... (all image files)
+├── dataset.csv
+└── README.md
+```
+
+-   **`images/`**: This directory contains all the image files of the traffic signs. These include both pristine digital assets (SVG/PNG renders) and will be augmented with real-world photos captured under various challenging conditions (e.g., blur, low quality, occlusions, snow, vandalism).
+-   **`dataset.csv`**: This CSV file serves as the primary metadata index for the dataset. Each row corresponds to a unique traffic sign image and contains the following fields:
+    -   `reference_id`: A unique identifier for the sign, often corresponding to official Quebec sign codes (e.g., `P-010-fr`, `P-120-10 (left)`).
+    -   `image`: The relative path to the image file within the `images/` directory (e.g., `images/P-010-fr.png`).
+    -   `explanation`: A short textual explanation or description of the sign's meaning or regulation. (Currently being populated, will include French and English versions in future iterations or a separate `metadata.jsonl`).
+    -   `url`: The original source URL from which the digital asset was downloaded (primarily Wikimedia Commons).
+
+## Data Collection and Annotation
+
+The initial phase of data collection focuses on digital assets sourced from Wikimedia Commons, which provides high-quality SVG renders of official Quebec road signs. These digital assets are processed to extract `reference_id` and `image_url`, and then downloaded locally.
+
+Future iterations will incorporate:
+-   **Real-world photos:** Images captured in urban environments (e.g., Montreal) under diverse conditions (varying lighting, weather, angles, partial obstructions, wear and tear, graffiti) to reflect real-world challenges.
+-   **Synthetic data generation:** Leveraging multimodal diffusion models (e.g., Stable Diffusion with ControlNet) to augment the dataset with synthetically generated images that simulate challenging real-world conditions, based on the pristine digital assets. This will significantly increase the dataset's robustness for edge cases.
+
+Annotations are currently derived from the `alt` attributes of image tags and will be enriched with detailed explanations (French and English) and structured metadata (e.g., `source`, `real_world_conditions`, `is_synthetic`) in a `metadata.jsonl` file for more advanced use cases.
+
+## Usage
+
+This dataset is designed to be easily loaded and used with the Hugging Face `datasets` library.
+
+```python
+from datasets import load_dataset
+
+# To load the dataset (once it's publicly available on the Hub)
+dataset = load_dataset("RDLTechworks/quebec-traffic-signs")
+
+# Example of accessing data
+# print(dataset["train"][0]["image"])
+# print(dataset["train"][0]["reference_id"])
+# print(dataset["train"][0]["explanation"])
+```
+
+## License
+
+This dataset is intended for research and non-commercial use. The images sourced from Wikimedia Commons are typically under Creative Commons licenses (e.g., CC BY-SA), and users should verify the specific license for each image if commercial use is intended. The metadata and annotations created for this dataset will be released under a permissive license (e.g., CC BY-SA 4.0).
+
+## Contact
+
+For questions or contributions, please contact [your-email@example.com] or visit the [RDLTechworks GitHub repository](https://github.com/RDLTechworks/quebec-traffic-signs) (placeholder).
+
+---