dataset info and dataset.py cleanup. Changed download url

Carla-COCO-Object-Detection-Dataset.py

@@ -1,18 +1,23 @@
 # coding=utf-8
-# Copyright 2021 The HuggingFace Datasets Authors and the current dataset script contributor.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""CPPE-5 dataset."""
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""Carla-COCO-Object-Detection-Dataset"""
 
 
 import collections
@@ -22,39 +27,32 @@ import os
 import datasets
 
 
-_CITATION = """\
-@misc{dagli2021cppe5,
-      title={CPPE-5: Medical Personal Protective Equipment Dataset},
-      author={Rishit Dagli and Ali Mustufa Shaikh},
-      year={2021},
-      eprint={2112.09569},
-      archivePrefix={arXiv},
-      primaryClass={cs.CV}
-}
-"""
-
 _DESCRIPTION = """\
-CPPE - 5 (Medical Personal Protective Equipment) is a new challenging dataset with the goal
-to allow the study of subordinate categorization of medical personal protective equipments,
-which is not possible with other popular data sets that focus on broad level categories.
+This dataset contains 1028 images each 640x380 pixels.
+The dataset is split into 249 test and 779 training examples.
+Every image comes with MS COCO format annotations.
+The dataset was collected in Carla Simulator, driving around in autopilot mode in various environments
+(Town01, Town02, Town03, Town04, Town05) and saving every i-th frame.
+The labels where then automatically generated using the semantic segmentation information.
 """
 
-_HOMEPAGE = "https://sites.google.com/view/cppe5"
+_HOMEPAGE = "https://github.com/yunusskeete/Carla-COCO-Object-Detection-Dataset"
 
-_LICENSE = "Unknown"
+_LICENSE = "MIT"
 
-# _URL = "https://drive.google.com/uc?id=1MGnaAfbckUmigGUvihz7uiHGC6rBIbvr"
-_URL = "https://huggingface.co/datasets/yunusskeete/cppe5/resolve/main/cppe5.tar.gz"
+_URL = "https://huggingface.co/datasets/yunusskeete/Carla-COCO-Object-Detection-Dataset/resolve/main/Carla-COCO-Object-Detection-Dataset.tar.gz"
 
 _CATEGORIES = ["automobile", "bike", "motorbike", "traffic_light", "traffic_sign"]
 
 
-class CPPE5(datasets.GeneratorBasedBuilder):
-    """CPPE - 5 dataset."""
+class CARLA_COCO(datasets.GeneratorBasedBuilder):
+    """Carla-COCO-Object-Detection-Dataset"""
 
-    VERSION = datasets.Version("1.0.0")
+    VERSION = datasets.Version("1.1.0")
 
     def _info(self):
+        """This method specifies the datasets.DatasetInfo object which contains informations and typings for the dataset"""
+
         features = datasets.Features(
             {
                 "image_id": datasets.Value("int64"),
@@ -76,10 +74,11 @@ class CPPE5(datasets.GeneratorBasedBuilder):
             features=features,
             homepage=_HOMEPAGE,
             license=_LICENSE,
-            citation=_CITATION,
         )
 
     def _split_generators(self, dl_manager):
+        """This method is tasked with downloading/extracting the data and defining the splits depending on the configuration"""
+
         archive = dl_manager.download(_URL)
         return [
             datasets.SplitGenerator(
@@ -98,7 +97,13 @@ class CPPE5(datasets.GeneratorBasedBuilder):
             ),
         ]
 
+    # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
     def _generate_examples(self, annotation_file_path, files):
+        """
+        This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        The `key` is for legacy reasons (tfds) and is not important in itself, but must be unique for each example.
+        """
+        
         def process_annot(annot, category_id_to_category):
             return {
                 "id": annot["id"],
@@ -134,54 +139,7 @@ class CPPE5(datasets.GeneratorBasedBuilder):
                 }
                 idx += 1
 
-# # coding=utf-8
-# # Permission is hereby granted, free of charge, to any person obtaining
-# # a copy of this software and associated documentation files (the
-# # "Software"), to deal in the Software without restriction, including
-# # without limitation the rights to use, copy, modify, merge, publish,
-# # distribute, sublicense, and/or sell copies of the Software, and to
-# # permit persons to whom the Software is furnished to do so, subject to
-# # the following conditions:
-
-# # The above copyright notice and this permission notice shall be
-# # included in all copies or substantial portions of the Software.
-
-# # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# """Carla-COCO-Object-Detection-Dataset"""
-
-# import collections
-# import json
-# import os
-
-# import datasets
-
-
-# logger = datasets.logging.get_logger(__name__)
-
-# _DESCRIPTION = """\
-# This dataset contains 1028 images each 640x380 pixels.
-# The dataset is split into 249 test and 779 training examples.
-# Every image comes with MS COCO format annotations.
-# The dataset was collected in Carla Simulator, driving around in autopilot mode in various environments
-# (Town01, Town02, Town03, Town04, Town05) and saving every i-th frame.
-# The labels where then automatically generated using the semantic segmentation information.
-# """
-
-# _HOMEPAGE = "https://github.com/yunusskeete/Carla-COCO-Object-Detection-Dataset"
-
-# _LICENSE = "MIT"
-
-# # _URL = "https://drive.google.com/uc?id=1QeveFt1jDNrafJeeCV1N_KoIKQEZyhuf"
-# # # _URL = "https://drive.google.com/uc?id=1xUPwrMBBrGFIapLx_fyLjmH4HN16A4iZ"
-# _URL = "https://huggingface.co/datasets/yunusskeete/Carla-COCO-Object-Detection-Dataset/resolve/main/Carla-COCO-Object-Detection-Dataset.tar.gz"
 
-# _CATEGORIES = ["automobile", "bike", "motorbike", "traffic_light", "traffic_sign"]
 
 # class CARLA_COCO(datasets.GeneratorBasedBuilder):
 #     """Carla-COCO-Object-Detection-Dataset"""

Carla-COCO-Object-Detection-Dataset.tar.gz

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:c5f5f1aef3d9c7b42b2c81c731bb4730e04155632efa4e9963d9d90adc3e06bc
+oid sha256:98b2b74c03d1229531cd588b2da3d210dd6bee995a255a7c5740eba4d18bbc33
 size 396705079

dataset_info.json

@@ -0,0 +1 @@
+{"description": "Hugging Face COCO-Style Labelled Dataset for Object Detection in Carla Simulator: This dataset contains 1028 images, each 640x380 pixels, with corresponding publically accessible URLs. The dataset is split into 249 test and 779 training examples. The dataset was collected in Carla Simulator, driving around in autopilot mode in various environments (Town01, Town02, Town03, Town04, Town05) and saving every i-th frame. The labels where then automatically generated using the semantic segmentation information.", "citation": "", "homepage": "https://github.com/yunusskeete/Carla-COCO-Object-Detection-Dataset", "license": "MIT", "features": {"image_id": {"dtype": "int64", "_type": "Value"}, "image": {"_type": "Image"}, "width": {"dtype": "int32", "_type": "Value"}, "height": {"dtype": "int32", "_type": "Value"}, "objects": {"feature": {"id": {"dtype": "int64", "_type": "Value"}, "area": {"dtype": "int64", "_type": "Value"}, "bbox": {"feature": {"dtype": "float32", "_type": "Value"}, "length": 4, "_type": "Sequence"}, "category": {"names": ["automobile", "bike", "motorbike", "traffic_light", "traffic_sign"], "_type": "ClassLabel"}}, "_type": "Sequence"}}, "builder_name": "Carla-COCO-Object-Detection-Dataset", "dataset_name": "Carla-COCO-Object-Detection-Dataset", "config_name": "default", "version": {"version_str": "1.1.0", "major": 1, "minor": 1, "patch": 0}, "download_checksums": {"https://huggingface.co/datasets/yunusskeete/cppe5/resolve/main/cppe5.tar.gz": {"num_bytes": 396704813, "checksum": "c5f5f1aef3d9c7b42b2c81c731bb4730e04155632efa4e9963d9d90adc3e06bc"}}, "download_size": 396704813, "dataset_size": 396736033, "size_in_bytes": 793440846}

dataset_infos.json

@@ -1 +0,0 @@
-{"default": {"description": "CPPE - 5 (Medical Personal Protective Equipment) is a new challenging dataset with the goal\nto allow the study of subordinate categorization of medical personal protective equipments,\nwhich is not possible with other popular data sets that focus on broad level categories.\n", "citation": "@misc{dagli2021cppe5,\n      title={CPPE-5: Medical Personal Protective Equipment Dataset},\n      author={Rishit Dagli and Ali Mustufa Shaikh},\n      year={2021},\n      eprint={2112.09569},\n      archivePrefix={arXiv},\n      primaryClass={cs.CV}\n}\n", "homepage": "https://sites.google.com/view/cppe5", "license": "Unknown", "features": {"image_id": {"dtype": "int64", "id": null, "_type": "Value"}, "image": {"id": null, "_type": "Image"}, "width": {"dtype": "int32", "id": null, "_type": "Value"}, "height": {"dtype": "int32", "id": null, "_type": "Value"}, "objects": {"feature": {"id": {"dtype": "int64", "id": null, "_type": "Value"}, "area": {"dtype": "int64", "id": null, "_type": "Value"}, "bbox": {"feature": {"dtype": "float32", "id": null, "_type": "Value"}, "length": 4, "id": null, "_type": "Sequence"}, "category": {"num_classes": 5, "names": ["automobile", "bike", "motorbike", "traffic_light", "traffic_sign"], "names_file": null, "id": null, "_type": "ClassLabel"}}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "cppe5", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 240481281, "num_examples": 779, "dataset_name": "cppe5"}, "test": {"name": "test", "num_bytes": 4172739, "num_examples": 249, "dataset_name": "cppe5"}}, "download_checksums": {"https://drive.google.com/uc?id=1MGnaAfbckUmigGUvihz7uiHGC6rBIbvr": {"num_bytes": 238482705, "checksum": "1151086e59fcb87825ecf4d362847a3f023ba69e7ace0f513d5aadc0e3dd3094"}}, "download_size": 238482705, "post_processing_size": null, "dataset_size": 244654020, "size_in_bytes": 483136725}}