Duplicate from pyronear/pyro-sdis

Co-authored-by: Mateo LOSTANLEN <[email protected]>

.gitattributes

@@ -0,0 +1,59 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mds filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,240 @@
+---
+license: apache-2.0
+dataset_info:
+  features:
+  - name: image
+    dtype: image
+  - name: annotations
+    dtype: string
+  - name: image_name
+    dtype: string
+  - name: partner
+    dtype: string
+  - name: camera
+    dtype: string
+  - name: date
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 2940743706.011
+    num_examples: 29537
+  - name: val
+    num_bytes: 391545545.068
+    num_examples: 4099
+  download_size: 3284043758
+  dataset_size: 3332289251.079
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+  - split: val
+    path: data/val-*
+tags:
+- wildfire
+- smoke
+- yolo
+- pyronear
+- ultralytics
+size_categories:
+- 10K<n<100K
+---
+
+# Pyro-SDIS Dataset
+
+![Pyronear Logo](https://huggingface.co/datasets/pyronear/pyro-sdis/resolve/main/logo.png)
+
+
+---
+
+## About the Dataset
+
+Pyro-SDIS is a dataset designed for wildfire smoke detection using AI models. It is developed in collaboration with the Fire and Rescue Services (SDIS) in France and the dedicated volunteers of the Pyronear association.
+
+The images in this dataset come from Pyronear cameras installed with the support of our SDIS partners. These images have been carefully annotated by Pyronear volunteers, whose tireless efforts we deeply appreciate. 
+
+We extend our heartfelt thanks to all Pyronear volunteers and our SDIS partners for their trust and support:
+
+- **Force 06**
+- **SDIS 07**
+- **SDIS 12**
+- **SDIS 77**
+
+Additionally, we express our gratitude to the DINUM for their financial and strategic support through the AIC, Etalab, and the Legal Service. Special thanks also go to the Mission Stratégie Prospective (MSP) for their guidance and collaboration.
+
+The Pyro-SDIS Subset contains **33,636 images**, including:
+
+- **28,103 images with smoke**
+- **31,975 smoke instances**
+
+This dataset is formatted to be compatible with the Ultralytics YOLO framework, enabling efficient training of object detection models.
+
+---
+
+Stay tuned for the full release in **January 2025**, which will include additional images and refined annotations. Thank you for your interest and support in advancing wildfire detection technologies!
+
+
+## Dataset Overview
+
+### Contents
+The Pyro-SDIS Subset contains images and annotations for wildfire smoke detection. The dataset is structured with the following metadata for each image:
+
+- **Image Path**: File path to the image.
+- **Annotations**: YOLO-format bounding box annotations for smoke detection:
+  - `class_id`: Class label (e.g., smoke).
+  - `x_center`, `y_center`: Normalized center coordinates of the bounding box.
+  - `width`, `height`: Normalized width and height of the bounding box.
+- **Metadata**:
+  - `partner`: Partner organization responsible for the camera (e.g., SDIS 07, Force 06).
+  - `camera`: Camera identifier.
+  - `date`: Date of image capture (formatted as `YYYY-MM-DDTHH-MM-SS`).
+  - `image_name`: Original file name of the image.
+- **Split**: Indicates whether the image belongs to the training or validation set (`train` or `val`).
+
+### Example Record
+Each record in the dataset contains the following structure:
+```json
+{
+  "image": "./images/train/partner_camera_date.jpg",
+  "annotations": "0 0.5 0.5 0.1 0.2",
+  "split": "train",
+  "image_name": "partner_camera_date.jpg",
+  "partner": "partner",
+  "camera": "camera",
+  "date": "YYYY-MM-DDTHH-MM-SS"
+}
+```
+
+---
+
+Let me know if you’d like further refinements or if you want me to include specific numbers/statistics for the dataset.
+
+### Splits
+The dataset is divided into:
+- **Training split**: Used for training the model.
+- **Validation split**: Used to evaluate model performance.
+
+
+
+## Exporting the Dataset for Ultralytics Training
+
+To train a YOLO model using the Ultralytics framework, the dataset must be structured as follows:
+- **Images**: Stored in `images/train/` and `images/val/` directories.
+- **Annotations**: Stored in YOLO-compatible format in `labels/train/` and `labels/val/` directories.
+
+### Steps to Export the Dataset
+
+1. **Install Required Libraries**:
+   ```bash
+   pip install datasets ultralytics
+   ```
+
+2. **Define Paths**:
+   Set up the directory structure for the Ultralytics dataset:
+   ```python
+   import os
+   from datasets import load_dataset
+
+   # Define paths
+   REPO_ID = "pyronear/pyro-sdis"
+   OUTPUT_DIR = "./pyro-sdis"
+   IMAGE_DIR = os.path.join(OUTPUT_DIR, "images")
+   LABEL_DIR = IMAGE_DIR.replace("images", "labels")
+
+   # Create the directory structure
+   for split in ["train", "val"]:
+       os.makedirs(os.path.join(IMAGE_DIR, split), exist_ok=True)
+       os.makedirs(os.path.join(LABEL_DIR, split), exist_ok=True)
+
+   # Load the dataset from the Hugging Face Hub
+   dataset = load_dataset(REPO_ID)
+   ```
+
+3. **Export Dataset**:
+   Use the following function to save the dataset in Ultralytics format:
+   ```python
+   def save_ultralytics_format(dataset_split, split):
+       """
+       Save a dataset split into the Ultralytics format.
+       Args:
+           dataset_split: The dataset split (e.g., dataset["train"])
+           split: "train" or "val"
+       """
+       for example in dataset_split:
+           # Save the image to the appropriate folder
+           image = example["image"]  # PIL.Image.Image
+           image_name = example["image_name"]  # Original file name
+           output_image_path = os.path.join(IMAGE_DIR, split, image_name)
+
+           # Save the image object to disk
+           image.save(output_image_path)
+
+           # Save label
+           annotations = example["annotations"]
+           label_name = image_name.replace(".jpg", ".txt").replace(".png", ".txt")
+           output_label_path = os.path.join(LABEL_DIR, split, label_name)
+           
+           with open(output_label_path, "w") as label_file:
+               label_file.write(annotations)
+
+   # Save train and validation splits
+   save_ultralytics_format(dataset["train"], "train")
+   save_ultralytics_format(dataset["val"], "val")
+
+   print("Dataset exported to Ultralytics format.")
+   ```
+
+4. **Directory Structure**:
+   After running the script, the dataset will have the following structure:
+   ```
+   pyro-sdis/
+   ├── images/
+   │   ├── train/
+   │   ├── val/
+   ├── labels/
+   │   ├── train/
+   │   ├── val/
+   ```
+
+---
+
+### Training with Ultralytics YOLO
+
+1. **Download the `data.yaml` File**:
+   Use the following code to download the configuration file:
+   ```python
+    from huggingface_hub import hf_hub_download
+    
+    # Correctly set repo_id and repo_type
+    repo_id = "pyronear/pyro-sdis"
+    filename = "data.yaml"
+    
+    # Download data.yaml to the current directory
+    yaml_path = hf_hub_download(repo_id=repo_id, filename=filename, repo_type="dataset", local_dir=".")
+    print(f"data.yaml downloaded to: {yaml_path}")
+   ```
+
+2. **Train the Model**:
+   Install the Ultralytics YOLO framework and train the model:
+   ```bash
+   pip install ultralytics
+   yolo task=detect mode=train data=data.yaml model=yolov8n.pt epochs=50 imgsz=640 single_cls=True
+   ```
+
+
+## License
+
+The dataset is released under the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+## Citation
+
+If you use this dataset, please cite:
+```
+@dataset{pyro-sdis,
+  author = {Pyronear Team},
+  title = {Pyro-SDIS Dataset},
+  year = {2024},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/pyronear/pyro-sdis}
+}
+```

data.yaml

@@ -0,0 +1,6 @@
+# data.yaml
+train: pyro-sdis/images/train  # Path to training images
+val: pyro-sdis/images/val      # Path to validation images
+
+nc: 1  # Number of classes
+names: ['smoke']  # Class names

data/train-00000-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7cebaeff1d94d23513a59a5652ce04303d02297dd6126dbf9d4ea0d37d7eabae
+size 480959863

data/train-00001-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:feb69d99b41e42cf9d73582ef2ff4237c7bbf5ad3f733a5ca0418e00795bd5b5
+size 485351693

data/train-00002-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:79ac3a22306cdafad474b4f56288b254d400e30ef1b2ed7d1e961cefd32e6858
+size 482115894

data/train-00003-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ce112887c5eb1a44fe4e5bae6843714a9574c89fa5d5215580b1e2ed4b64822e
+size 482865791

data/train-00004-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1352d4d6b2443019fac83967b463bd0daab9030987363f26bae4ba8691653884
+size 479975330

data/train-00005-of-00006.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:05c000f07253dd60858a629119a5a2d94c8f8427b54f6f2fd503bbe06f933065
+size 482940251

data/val-00000-of-00001.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d3929f81f755625e35c8b18f27f95cff8726bc279cedaf1c3d048b0fd35d6c57
+size 389834936