Add files using upload-large-folder tool

README.md

@@ -3,88 +3,157 @@ license: eupl-1.2
 language:
 - nl
 ---
-# Vuurwerkverkenner
+# NFI Fireworks training dataset for the "Vuurwerkverkenner" application
 
-This dataset is used by the Vuurwerkverkenner, an application for linking snippets of exploded (heavy) fireworks to the type of firework that they originate from. 
-You may find the application at [www.vuurwerkverkenner.nl](https://www.vuurwerkverkenner.nl). 
-The dataset consists of different types of fireworks that were investigated in casework by the Netherlands Forensic Institute. 
+The Netherlands Forensic Institute (NFI) Fireworks training dataset consists of scans of fireworks wrappers from fireworks that were investigated in casework in 
+the Netherlands between 2010 and early 2024. For a subset of these wrappers, photographs of fireworks snippets (pieces of the wrapper after the detonation) were added.
 
-## Categories
+## Data overview
 
-If firework wrappers are very similar in their visual appearance, they may be grouped into categories. 
-In most cases, a wrapper is not similar to any other wrapper, and a category simply consists of one unique wrapper.  
+The data consists of 331 wrappers in 184 categories. There are 37 categories with more than one wrapper, and snippets are available for 38 wrapper categories.
 
-## Contents
+### Data collection
 
-The dataset consists of 217 categories, containing 347 unique wrappers in total. The dataset is organized as follows: 
+For the fireworks wrappers, all wrappers physically available at the NFI Explosives team from casework between 2010-2024 were scanned. 
 
+For the collection of the fireworks snippets, fireworks were exploded and snippets that resulted were gathered by hand. Snippets were cleaned, dried and sorted by wrapper. 
+Snippets were then photographed on a white background. One snippet photo contains multiple snippets.
 
-```
-reference_data 
-└───bigboy 
-  └─── big boy xl 
-    └─── wrapper.png 
-    └─── compleet exemplaar.png
-  └─── bigboy
-    └─── wrapper.png 
-    └─── compleet exemplaar.png
-└───atomyc 
-  └─── atomyc 3 
-    └─── wrapper.png
-    └─── compleet exemplaar.png
-    └─── gedemonteerd.png
-└───meta.json.gz 
-```
+Sampling was done based on availability of fireworks in the data collection period. To diversify and increase the dataset, additional wrappers were chosen to print and glue 
+to Cobra 6 fireworks. This selection was done in collaboration with domain experts. 
+
+## Data structure
 
-The first level of folders (`bigboy`, `atomyc`, ...) corresponds to the category of fireworks. 
-The second level (`big boy xl`, `atomyc 3`, ...) corresponds to the specific wrappers within the category. 
-For each wrapper, one or multiple images may be present. 
-In each case, `wrapper.png` should be present, which is a scan of the full wrapper. 
-Additionally, other images may be present as well, such as the entire fireworks article or a schematic drawing of its contents. 
+Each folder (e.g. fireworks_0) is a firework category. Firework types have been grouped if wrappers were the same or very similar. For instance, variants of the same fireworks 
+from different years, such as a Cobra 6 from 2018 and 2019, were considered very similar. Wrappers were categorised in collaboration with domain experts.
 
-In `meta.json.gz`, we store both *metadata* and *reference embeddings* for the firework categories. It has the following structure: 
+Each folder contains at least one wrapper. Additionally, a folder can contain multiple snippet photos (snippets_0.jpg, snippets_1.jpg etc.) if they were available for that wrapper category.
+
+The data structure visualised: 
 
 ```
-{ 
-  "bigboy": {
-    "big boy xl": {
-      "embeddings": [[...], [...], ...], 
-      "wrappers": {
-          "wrapper_text": "abcdef", 
-          "article_name": "abc",
-          ... 
-        },
-      }, 
-    }, 
-} 
+└───  fireworks_0
+     └───wrapper_0.jpg
+     └───wrapper_1.jpg
+     └───wrapper_2.jpg
+     └───snippets_0.jpg
+     └───snippets_1.jpg
+└───  fireworks_1
+     └─── wrapper_0.jpg
+└───  fireworks_2
+     └─── wrapper_0.jpg
+     └─── wrapper_1.jpg
+└───  fireworks_2
+     └─── wrapper_0.jpg
+     └─── snippets_0.jpg
 ```
-
-The first level (`meta['bigboy']`, `meta['buttferfly']`, ...) indicates the fireworks category, which corresponds to the first level of the photo folders (i.e. `meta[0]` matches the folder `bigboy`).  
-The second level (`meta['bigboy']['big boy xl']`, `meta['bigboy']['bigboy']`, ...) indicated the individual wrappers beloning the fireworks category, which corresponds to the second leel of the photo folders (i.e. `meta['bigboy']['big boy xl']` matches the folder `bigboy/big boy xl`). 
-Each wrapper contains the reference embeddings and the metadata for each wrapper.  
-The third level, e.g. `meta['bigboy']['big boy xl']['wrappers’]`, indicates the wrapper within the category and corresponds to the photo folder of that wrapper (e.g. `bigboy/big boy xl/wrapper.png`). On the same level are also the embeddings stored, which will be used to match our predictions of pictures with.
-
-### _Reference embeddings_
-
-For each category, reference embeddings are provided. 
-They are constructed by an AI model that is trained to create embeddings for (photos of) firework wrappers and snippets of exploded wrappers. 
-When fed to this model, photos of snippets that belong to a given category should have similar embeddings to the ones for the wrappers. 
-For more details about the model, see (here)[https://huggingface.co/NetherlandsForensicInstitute/vuurwerkverkenner]. 
-
-### _Metadata_
-
-For each wrapper, metadata is provided. The fields are described below. 
-
-| Field                         | Description                                         | 
-|-------------------------------|-----------------------------------------------------| 
-| `text`                        | The full text that is on the wrapper (excluding non-Latin alphabets).             | 
-| `endangerment`                | The level of danger or risk associated with the firework.             | 
-| `article_name`                | The name of the item.                    | 
-| `firework_type`               | The type of firework.                               | 
-| `firework_category`           | The category or classification of the firework.     | 
-| `tube_length`                 | The length of the tube.          | 
-| `tube_diameter`               | The diameter of the tube.        | 
-| `composition_burst_charge`    | The composition of the main charge of the firework.                | 
-| `composition_other_mixtures`  | The composition of other charges of the firework.             | 
-| `mass_burst_charge`           | The mass of the main charge.    | 
-| `mass_other_mixtures`         | The mass of other charges. |
+ 
+## Firework wrappers 
+
+Wrappers have been scanned and the images have been reduced in size to a maximum of 2000 pixels in either height or width.
+
+### Categorisation
+
+Categories with more than one wrapper:
+
+| Category        | Number of wrappers |
+| --------------- | ------------------ |
+| fireworks_2     | 2                  |
+| fireworks_6     | 2                  |
+| fireworks_12    | 3                  |
+| fireworks_13    | 2                  |
+| fireworks_17    | 2                  |
+| fireworks_24    | 2                  |
+| fireworks_25    | 2                  |
+| fireworks_30    | 3                  |
+| fireworks_32    | 2                  |
+| fireworks_33    | 2                  |
+| fireworks_37    | 3                  |
+| fireworks_46    | 3                  |
+| fireworks_51    | 5                  |
+| fireworks_53    | 2                  |
+| fireworks_56    | 3                  |
+| fireworks_59    | 3                  |
+| fireworks_61    | 58                 |
+| fireworks_62    | 9                  |
+| fireworks_63    | 2                  |
+| fireworks_64    | 3                  |
+| fireworks_74    | 2                  |
+| fireworks_78    | 3                  |
+| fireworks_82    | 4                  |
+| fireworks_92    | 2                  |
+| fireworks_97    | 2                  |
+| fireworks_111   | 2                  |
+| fireworks_117   | 2                  |
+| fireworks_135   | 2                  |
+| fireworks_139   | 4                  |
+| fireworks_144   | 8                  |
+| fireworks_145   | 11                 |
+| fireworks_151   | 12                 |
+| fireworks_153   | 4                  |
+| fireworks_154   | 4                  |
+| fireworks_158   | 3                  |
+| fireworks_166   | 2                  |
+| fireworks_179   | 4                  |
+
+
+Categories with snippet collections:
+
+| Category        | Number of snippet collections  |
+| --------------- | ------------------------------ |
+| fireworks_8     | 3                              |
+| fireworks_12    | 4                              |
+| fireworks_17    | 6                              |
+| fireworks_30    | 1                              |
+| fireworks_37    | 1                              |
+| fireworks_38    | 3                              |
+| fireworks_47    | 1                              |
+| fireworks_54    | 6                              |
+| fireworks_58    | 5                              |
+| fireworks_59    | 6                              |
+| fireworks_61    | 14                             |
+| fireworks_62    | 1                              |
+| fireworks_71    | 3                              |
+| fireworks_75    | 2                              |
+| fireworks_82    | 2                              |
+| fireworks_86    | 6                              |
+| fireworks_87    | 2                              |
+| fireworks_95    | 1                              |
+| fireworks_97    | 2                              |
+| fireworks_105   | 1                              |
+| fireworks_106   | 1                              |
+| fireworks_116   | 4                              |
+| fireworks_119   | 1                              |
+| fireworks_129   | 1                              |
+| fireworks_137   | 1                              |
+| fireworks_139   | 5                              |
+| fireworks_144   | 5                              |
+| fireworks_145   | 16                             |
+| fireworks_148   | 2                              |
+| fireworks_153   | 11                             |
+| fireworks_154   | 2                              |
+| fireworks_158   | 3                              |
+| fireworks_160   | 1                              |
+| fireworks_169   | 3                              |
+| fireworks_174   | 1                              |
+| fireworks_176   | 2                              |
+| fireworks_179   | 1                              |
+| fireworks_182   | 3                              |
+
+
+
+## Training
+
+The steps followed at the NFI to actually train the model with these data, are described in the model card of the Vuurwerkverkenner at https://huggingface.co/NetherlandsForensicInstitute/vuurwerkverkenner (also linked to this data set).
+
+
+### Possible bias
+
+The reference set of firework wrappers is dependent on which fireworks were investigated by the NFI. 
+This may not be representative for fireworks in other countries or in the future. 
+
+Data collection of snippets was influenced by the availability of fireworks. Due to low availability, some snippets are the result of 
+wrappers glued to Cobra 6 fireworks instead of the original fireworks. We noticed that these wrappers tended to detach more easily than wrappers on 
+original firework. This may have influenced the snippet creation.
+
+Very small snippets were not included in our dataset.

README_new.md

@@ -0,0 +1,350 @@
+---
+license: eupl-1.2
+language:
+- nl
+---
+# NFI Fireworks training dataset for the "Vuurwerkverkenner" application
+
+The Netherlands Forensic Institute (NFI) Fireworks training dataset consists of scans of fireworks wrappers from fireworks that were investigated in casework in 
+the Netherlands between 2010 and 2025. For a subset of these wrappers, photographs of fireworks snippets (pieces of the wrapper after the detonation) were added.
+
+## Data overview
+
+The data consists of 347 wrappers in 216 categories. There are 36 categories with multiple wrappers, and snippets are available for 216 wrapper categories.
+
+### Data collection
+
+For the fireworks wrappers, all wrappers physically available at the NFI Explosives team from casework between 2010-2025 were scanned. 
+
+For the collection of the fireworks snippets, fireworks were exploded and snippets that resulted were gathered by hand. Snippets were cleaned, dried and sorted by wrapper. 
+Snippets were then photographed on a white background. One snippet photo contains multiple snippets.
+
+Sampling was done based on availability of fireworks in the data collection period. To diversify and increase the dataset, additional wrappers were chosen to print and glue 
+to Cobra 6 fireworks. This selection was done in collaboration with domain experts. 
+
+## Data structure
+
+The root level of our data structure is organized by the method of data collection. For instance, the artificial_snippets folder contains virtual snippets created artificially, while real_snippets comprises images of real exploded fireworks.
+
+Within each data collection method folder, the data is further divided into train, test, and validation folders. These divisions help in training our model effectively. In addition, the artificial_snippets folder includes a reference folder, which holds data used to calculate reference embeddings.
+
+Moving to the third layer, each folder represents a firework category. Firework types are grouped based on the similarity of their wrappers. For example, variants from different years, like Cobra 6 from 2018 and 2019, are considered similar due to their wrapper design. These categorizations were made with the assistance of domain experts.
+
+The final layer contains folders named after specific firework wrappers. Each of these folders includes multiple images of snippets (e.g., 0.png, 1.png) if they are available for that particular wrapper category.
+
+Below is a visual representation of the data structure:
+
+```
+└───  artificial_snippets
+     └───reference
+          └───cobrawit
+                └───cobra t.t.
+                     └───0.png
+                     └───1.png
+                     └───2.png
+          └───butterfly
+                └───cobra t.t.
+                     └───0.png
+                     └───1.png
+                     └───2.png
+          └───supertop
+     └───train
+     └───test
+     └───val
+└───  mock_snippets
+     └───train
+     └───test
+     └───val
+└───  real_snippets
+     └───train
+     └───test
+     └───val
+
+```
+ 
+## Firework wrappers 
+
+Wrappers have been scanned, and the images have been reduced in size to a maximum of 2000 pixels in either height or width.
+
+### Categorisation
+
+Categories with multiple wrappers:
+
+| Category        | Number of wrappers |
+| --------------- | ------------------ |
+| atomyc          | 4                  |
+| mascleta        | 2                  |
+| bigboy          | 3                  |
+| dumbumzwart     | 12                 |
+| blackvlinder    | 2                  |
+| blackwidow      | 3                  |
+| bluestorm1      | 2                  |
+| caramella2      | 3                  |
+| chooet          | 2                  |
+| cobrazwart      | 63                 |
+| zink2           | 3                  |
+| zink3           | 3                  |
+| tuonogolf       | 4                  |
+| tuonorood       | 2                  |
+| tuonovuur       | 2                  |
+| tuonogoud       | 2                  |
+| viperzwart      | 4                  |
+| xplode          | 2                  |
+| cobrazilver     | 5                  |
+| crazyrobots     | 2                  |
+| delovarana1     | 2                  |
+| delovarana2     | 2                  |
+| thunderstorm    | 2                  |
+| dumbumzwartrood  | 2                  |
+| dumbumzwartzilver  | 3                  |
+| jorge2          | 2                  |
+| horror          | 2                  |
+| jr101           | 2                  |
+| lupo            | 3                  |
+| match_cracker1  | 2                  |
+| retorno2        | 2                  |
+| petarde         | 2                  |
+| profi           | 2                  |
+| shark2          | 2                  |
+| scream          | 10                 |
+| shark1          | 2                  |
+
+
+Categories with snippet collections:
+
+| Category        | Number of snippet collections |
+| --------------- | ----------------------------- |
+| match_cracker2  | 33                            |
+| shell2          | 33                            |
+| shell1          | 33                            |
+| 3040            | 33                            |
+| ghost1          | 33                            |
+| achtung2        | 33                            |
+| achtung_skull   | 33                            |
+| achtung1        | 33                            |
+| alarm5          | 33                            |
+| appletrate      | 33                            |
+| aquilacentinaio  | 33                            |
+| zorro           | 33                            |
+| atomyc          | 132                           |
+| mascleta        | 66                            |
+| bigboy          | 99                            |
+| dumbumzwart     | 396                           |
+| bigjumbo        | 33                            |
+| bigthunder      | 33                            |
+| bigtigertropic  | 33                            |
+| blackdeath      | 33                            |
+| blackthunder1   | 33                            |
+| blackthunder2   | 33                            |
+| blackthunder3   | 33                            |
+| blackvlinder    | 66                            |
+| blackwidow      | 99                            |
+| blitzschlag     | 33                            |
+| bluestorm1      | 66                            |
+| bluestorm2      | 33                            |
+| zink1           | 33                            |
+| bomb1           | 33                            |
+| bomb2           | 33                            |
+| butterfly       | 33                            |
+| caramella1      | 33                            |
+| caramella2      | 99                            |
+| celebrationcracker  | 33                            |
+| chooet          | 66                            |
+| circoblitz      | 33                            |
+| cobrazwart      | 2079                          |
+| zink2           | 99                            |
+| zink4           | 33                            |
+| zink3           | 99                            |
+| zink5           | 33                            |
+| signalrakete901blauw  | 33                            |
+| silverdemon     | 33                            |
+| siouxwarior     | 33                            |
+| sp1010          | 33                            |
+| spanishcracker  | 33                            |
+| stielhandgranate  | 33                            |
+| succubus        | 33                            |
+| supercracker    | 33                            |
+| superexplosion2  | 33                            |
+| superexplosion4  | 33                            |
+| superexplosion1  | 33                            |
+| superexplosion3  | 33                            |
+| supertop        | 33                            |
+| thumpingthunder  | 33                            |
+| thundercracker  | 33                            |
+| thunderking     | 33                            |
+| tigerboom       | 33                            |
+| titan           | 33                            |
+| shell5          | 33                            |
+| tp2             | 33                            |
+| tuonoblauw      | 33                            |
+| tuonogolf       | 132                           |
+| tuonorood       | 66                            |
+| tuonovuur       | 66                            |
+| tuonogoud       | 66                            |
+| tuonott4        | 33                            |
+| txp001          | 33                            |
+| viperbruin      | 33                            |
+| vipergeel       | 33                            |
+| viperzwart      | 132                           |
+| viperrood       | 33                            |
+| viper2          | 33                            |
+| virus3          | 33                            |
+| virus           | 33                            |
+| vlinder1        | 33                            |
+| xplode          | 66                            |
+| yellowshock     | 33                            |
+| bulldog         | 33                            |
+| mario200        | 33                            |
+| monster1        | 33                            |
+| viperduo        | 33                            |
+| virus2          | 33                            |
+| blackthunder4   | 33                            |
+| euphoria        | 33                            |
+| bigboyboom      | 33                            |
+| duxmealux       | 33                            |
+| fotzenblitz     | 33                            |
+| padrino         | 33                            |
+| numero40        | 33                            |
+| numberone2      | 33                            |
+| shell4          | 33                            |
+| gigantmaroon2   | 33                            |
+| gun             | 33                            |
+| redbutterfly    | 33                            |
+| gretathunder1   | 33                            |
+| gretathunder2   | 33                            |
+| vitaminf50      | 33                            |
+| tirex           | 33                            |
+| panzerfaust1    | 33                            |
+| cobrazilver     | 165                           |
+| cobrawit        | 33                            |
+| cobratraat1     | 33                            |
+| cobratraat2     | 33                            |
+| colorreport     | 33                            |
+| colourflower    | 33                            |
+| bp0038p         | 33                            |
+| coloursalute    | 33                            |
+| corona          | 33                            |
+| torpedo         | 33                            |
+| crazybang       | 33                            |
+| crazyrobots     | 66                            |
+| delovarana3     | 33                            |
+| delovarana1     | 66                            |
+| delovarana2     | 66                            |
+| diablo (blauw)  | 33                            |
+| diablo (rood)   | 33                            |
+| diablo (zwart)  | 33                            |
+| dieptebom       | 33                            |
+| dinamite        | 33                            |
+| thunderstorm    | 66                            |
+| doppelschlag    | 33                            |
+| dragonboom1     | 33                            |
+| dragonboom2     | 33                            |
+| dumbumvuurretorno100  | 33                            |
+| dumbumzwartrood  | 66                            |
+| dumbumoranje    | 33                            |
+| dumbumzwartzilver  | 99                            |
+| echobomb        | 33                            |
+| ekstra_cobra    | 33                            |
+| cometa          | 33                            |
+| matabrujas      | 33                            |
+| raptor          | 33                            |
+| flashing thunder  | 33                            |
+| folgore         | 33                            |
+| nitraat9        | 33                            |
+| jorge1          | 33                            |
+| jorge2          | 66                            |
+| funkenschlag1   | 33                            |
+| funkenschlag2   | 33                            |
+| ghost2          | 33                            |
+| gigantmaroon1   | 33                            |
+| gladiator1      | 33                            |
+| gladiator2      | 33                            |
+| goldthunder     | 33                            |
+| gorillabomb     | 33                            |
+| handgranade     | 33                            |
+| horror          | 66                            |
+| joker2          | 33                            |
+| joker4          | 33                            |
+| jokerroze       | 33                            |
+| joker1          | 33                            |
+| joker3          | 33                            |
+| jr101           | 66                            |
+| kalasnikov      | 33                            |
+| kittywhr        | 33                            |
+| nitraat5        | 33                            |
+| 817             | 33                            |
+| krachmen        | 33                            |
+| labomba         | 33                            |
+| littlecooper    | 33                            |
+| lupo            | 99                            |
+| match_cracker1  | 66                            |
+| megabomb        | 33                            |
+| retorno2        | 66                            |
+| batterij fb     | 33                            |
+| nitraat11       | 33                            |
+| nitraat6        | 33                            |
+| napolitaansebom  | 33                            |
+| newrambo        | 33                            |
+| nitraat2        | 33                            |
+| nitraat3        | 33                            |
+| nitraat4        | 33                            |
+| nitrobomb       | 33                            |
+| numberone1      | 33                            |
+| cs1             | 33                            |
+| p1000           | 33                            |
+| nitraat8        | 33                            |
+| bombbon         | 33                            |
+| 859             | 33                            |
+| nitraat7        | 33                            |
+| petarde         | 66                            |
+| nitraat1        | 33                            |
+| profi           | 66                            |
+| shark2          | 66                            |
+| pyropower       | 33                            |
+| pyrostar        | 33                            |
+| rambo           | 33                            |
+| rastatraat      | 33                            |
+| reaper          | 33                            |
+| redbaron        | 33                            |
+| reddevil        | 33                            |
+| redflower       | 33                            |
+| redthunder      | 33                            |
+| retorno3        | 33                            |
+| retorno1        | 33                            |
+| rex1            | 33                            |
+| rocket2         | 33                            |
+| rocket3         | 33                            |
+| saperp2000      | 33                            |
+| schockerxxl     | 33                            |
+| scream          | 330                           |
+| screamineagle   | 33                            |
+| shark1          | 66                            |
+| shell3          | 33                            |
+| barracuda       | 33                            |
+| purplestorm     | 33                            |
+| pitbull         | 33                            |
+| lupoblauw       | 33                            |
+| pertardof2      | 33                            |
+| nebelschlagpaars  | 33                            |
+| nebelschlagrood  | 33                            |
+| nebelschlaggeel  | 33                            |
+| nebelschlagblauw  | 33                            |
+| explod          | 33                            |
+
+
+
+## Training
+
+The steps followed at the NFI to actually train the model with these data, are described in the model card of the Vuurwerkverkenner at https://huggingface.co/NetherlandsForensicInstitute/vuurwerkverkenner (also linked to this data set).
+
+
+### Possible bias
+
+The reference set of firework wrappers is dependent on which fireworks were investigated by the NFI. 
+This may not be representative for fireworks in other countries or in the future. 
+
+Data collection of snippets was influenced by the availability of fireworks. Due to low availability, some snippets are the result of 
+wrappers glued to Cobra 6 fireworks instead of the original fireworks. We noticed that these wrappers tended to detach more easily than wrappers on 
+original firework. This may have influenced the snippet creation.
+
+Very small snippets were not included in our dataset.