Upload folder using huggingface_hub

README.md

@@ -1,94 +1,96 @@
 ---
 license: eupl-1.2
 language:
-- nl
+  - en
 ---
+
 # Vuurwerkverkenner
 
-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. 
+This dataset is utilized by the Vuurwerkverkenner application to link fragments of exploded (heavy) fireworks to their
+originating firework types. You can explore the application
+at [www.vuurwerkverkenner.nl](https://www.vuurwerkverkenner.nl). The dataset includes various firework types examined in
+casework by the Netherlands Forensic Institute.
 
 ## Categories
 
-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.  
+Firework wrappers that closely resemble each other visually may be grouped into categories. Typically, a wrapper stands
+alone without resemblance to others, forming a category with one unique wrapper.
 
 ## Contents
 
-The dataset consists of 185 categories, containing 332 unique wrappers in total. The dataset is organized as follows: 
-
+The dataset comprises 217 categories, featuring a total of 347 unique wrappers. It
+is organized as follows:
 
 ```
-vuurwerkverkenner-data 
-└───fireworks_0 
-  └─── wrappers 
-    └─── 0 
-      └─── wrapper.jpg 
-      └─── compleet exemplaar.jpg
-      └─── gedemonteerd.jpg
-    └─── 1 
-      └─── wrapper.jpg 
-      └─── compleet exemplaar.jpg 
-      └─── gedemonteerd.jpg 
-└───fireworks_1 
-  └─── wrappers 
-    └─── 0 
-      └─── wrapper.jpg 
+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 
 ```
 
-The first level of folders (`fireworks_0`, `fireworks_1`, ...) corresponds to the category. 
-The third level (`0`, `1`, ...) corresponds to the wrappers within the category. 
-For each wrapper, one or multiple images may be present. 
-In each case, `wrapper.jpg` 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. 
+The top-level folders (`bigboy`, `atomyc`, ...) indicate the firework categories. The next level (`big boy xl`, 
+`atomyc 3`, ...)
+identifies specific wrappers within each category. For each wrapper, one or more images may be included. At a minimum,
+`wrapper.png`, a scan of the complete wrapper, is present. Additional images, like photographs of the whole firework
+article or schematic drawings of its internals, may also be available.
 
-In `meta.json.gz`, we store both *metadata* and *reference embeddings* for the firework categories. It has the following structure: 
+In `meta.json.gz`, both metadata and reference embeddings for each firework category are stored. It aligns in structure 
+as follows:
 
 ```
 { 
-  0: {
-    "embeddings": [[...], [...], ...], 
-    "wrappers": [ 
-      0: {
-        "wrapper_text": "abcdef", 
-        "article_name": "abc",
-        ... 
+  "bigboy": {
+    "big boy xl": {
+      "embeddings": [[...], [...], ...], 
+      "wrappers": {
+          "wrapper_text": "abcdef", 
+          "article_name": "abc",
+          ... 
+        },
       }, 
-      1: {...},
-      2: {...} 
-    ] 
-  }, 
-  1: {...} 
+    }, 
 } 
 ```
 
-The first level (`meta[0]`, `meta[1]`, `meta[2]` ...) indicates the fireworks category, which corresponds to the first level of the photo folders (i.e. `meta[0]` matches the folder `fireworks_0`).  
-Each category contains the reference embeddings and the metadata for each wrapper.  
-The third level, e.g. `meta[0]['wrappers’][0]`, indicates the wrapper within the category and corresponds to the photo folder of that wrapper (e.g. `fireworks_0/wrappers/0`). 
+The first level (`meta['bigboy']`, `meta['butterfly']`, ...) denotes the firework category corresponding to the top level
+of photo folders (e.g., `meta[0]` matches the folder `bigboy`). The second level (`meta['bigboy']['big boy xl']`,
+`meta['bigboy']['bigboy']`, ...) identifies individual wrappers within the category, aligning with the second level of
+photo folders (e.g., `meta['bigboy']['big boy xl']` corresponds to `bigboy/big boy xl`). Each wrapper holds reference
+embeddings and metadata. The third level, such as `meta['bigboy']['big boy xl']['wrappers']`, aligns with a specific
+wrapper's photo folder (like `bigboy/big boy xl/wrapper.png`). Embeddings stored at this level are used to compare
+embeddings of uploaded images in the application 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]. 
+Reference embeddings are provided for each category. These are generated by an AI model trained to create embeddings for
+firework wrappers and exploded wrapper snippets. When snippets from a category are fed into the model, they should yield
+similar embeddings to those for the wrappers. For further details on 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. |
+Metadata for each wrapper includes various fields, described as follows:
+
+| Field                        | Description                                                       | 
+|------------------------------|-------------------------------------------------------------------| 
+| `text`                       | Full text present 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.                                        |