Update README.md

README.md

@@ -1,71 +1,106 @@
 ---
-dataset_info:
-  features:
-  - name: image_id
-    dtype: int64
-  - name: image
-    dtype: image
-  - name: width
-    dtype: int64
-  - name: height
-    dtype: int64
-  - name: objects
-    sequence:
-    - name: bbox
-      sequence: float32
-      length: 4
-    - name: category
-      dtype:
-        class_label:
-          names:
-            '0': weapons
-            '1': Aggressor
-            '2': Blood
-            '3': Guns
-            '4': Guns perspective
-            '5': Hand
-            '6': Heavy Gun
-            '7': Knife
-            '8': Knife_Deploy
-            '9': Knife_Weapon
-            '10': Long guns
-            '11': Person
-            '12': Pistol
-            '13': Rifle
-            '14': Shotgun
-            '15': Stabbing
-            '16': Victim
-            '17': al
-            '18': guns
-            '19': handgun
-            '20': heavyweapon
-            '21': larga
-            '22': person
-            '23': pistol
-            '24': pistols
-            '25': rifle
-            '26': shotgun
-            '27': violence
-            '28': weapon
-  splits:
-  - name: train
-    num_bytes: 444829039.988
-    num_examples: 5871
-  - name: validation
-    num_bytes: 72917317.116
-    num_examples: 1491
-  - name: test
-    num_bytes: 119828512.98
-    num_examples: 2295
-  download_size: 582992013
-  dataset_size: 637574870.084
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
+license: cc-by-4.0
+tags:
+- object-detection
+- image-classification
+- computer-vision
+- weapons
+- security
+task_categories:
+- image-classification
+language:
+- en
+size_categories:
+- 1K<n<10K
 ---
+
+# Weapon and Threat Detection Dataset
+
+This dataset is a cleaned, restructured, and ready-to-use version of a comprehensive object detection dataset for identifying weapons, aggressors, and other security-related items. It has been specifically formatted for easy use with the Hugging Face `datasets` library and modern training frameworks like `ultralytics` for YOLO models.
+
+## Original Source
+
+This dataset is a derivative work based on the **[weapon-detection Object Detection Model](https://universe.roboflow.com/yolov7test-pdxwq/weapon-detection-m7tpo)** dataset, originally created and shared by **yolov7test** on Roboflow Universe.
+
+All images and original annotations belong to the original author. This version was created to resolve data integrity issues, including inconsistent filenames and directory structures, to prepare it for robust training.
+
+## Dataset Details
+
+The dataset is divided into three splits for standard model training and evaluation workflows.
+
+* **Train:** 5,871 images
+* **Validation:** 1,491 images
+* **Test:** 2,295 images
+
+### Classes
+
+The dataset contains **29 distinct classes** for object detection:
+`'weapons'`, `'Aggressor'`, `'Blood'`, `'Guns'`, `'Guns perspective'`, `'Hand'`, `'Heavy Gun'`, `'Knife'`, `'Knife_Deploy'`, `'Knife_Weapon'`, `'Long guns'`, `'Person'`, `'Pistol'`, `'Rifle'`, `'Shotgun'`, `'Stabbing'`, `'Victim'`, `'al'`, `'guns'`, `'handgun'`, `'heavyweapon'`, `'larga'`, `'person'`, `'pistol'`, `'pistols'`, `'rifle'`, `'shotgun'`, `'violence'`, `'weapon'`
+
+## Dataset Structure
+
+Each item in the dataset is a dictionary with the following structure:
+
+```python
+{
+    'image_id': 5,
+    'image': <PIL.JpegImagePlugin.JpegImageFile image>,
+    'width': 640,
+    'height': 640,
+    'objects': {
+        'bbox': [
+            [250.0, 150.0, 100.5, 200.0], 
+            # ... more boxes
+        ],
+        'category': [
+            12, # Corresponds to 'Pistol'
+            # ... more category IDs
+        ]
+    }
+}
+```
+
+- `image_id`: A unique integer identifier for the image.
+
+- `image`: The image object itself, in PIL format.
+
+- `width`,`height`: The dimensions of the image.
+
+- `objects`: A dictionary containing the bounding box annotations.
+
+- `bbox`: A list of bounding boxes, each in the COCO format [x_min, y_min, width, height].
+
+- `category`: A list of corresponding integer class labels. The mapping from integer to class name can be found in the dataset's features.
+
+# How to Use
+You can easily load this dataset using the datasets library:
+
+```Python
+
+from datasets import load_dataset
+
+# Load the dataset from the Hugging Face Hub
+dataset = load_dataset("Subh775/WeaponDetection")
+
+# Access a specific split
+train_dataset = dataset["train"]
+
+# Print the first example
+print(train_dataset[0])
+```
+
+# Citation
+If you use this dataset in your work, please cite the original creator and provide a link to the Roboflow Universe page.
+
+```BibTeX:
+
+Code snippet
+
+@misc{yolov7test_weapon_detection,
+    title={Weapon Detection Object Detection Model},
+    author={yolov7test},
+    howpublished={\url{[https://universe.roboflow.com/yolov7test-pdxwq/weapon-detection-m7tpo](https://universe.roboflow.com/yolov7test-pdxwq/weapon-detection-m7tpo)}},
+    year={2022}
+}
+```
+