Update README.md

README.md

@@ -44,17 +44,94 @@ dataset_info:
     path: data/transport/*.parquet
 ---
 
+
 > [!NOTE]
 > Dataset origin: https://live.european-language-grid.eu/catalogue/corpus/18029/
 
 
-> [!WARNING]
-> We recommend you download the data with huggingface_hub lib by selecting the folders of interest in https://huggingface.co/datasets/FrancophonIA/MIC21/tree/main
 
-## Description
+# MIC21
+
+## Original description
 One of the processing tasks for large multimodal data streams is automatic image description (image classification, object segmentation and classification). Although the number and the diversity of image datasets is constantly expanding, still there is a huge demand for more datasets in terms of variety of domains and object classes covered. The goal of the project Multilingual Image Corpus (MIC 21) is to provide a large image dataset with annotated objects and object descriptions in 24 languages. The Multilingual Image Corpus consists of an Ontology of visual objects (based on WordNet) and a collection of thematically related images whose objects are annotated with segmentation masks and labels describing the ontology classes. The dataset is designed both for image classification and object detection and for semantic segmentation. The main contributions of our work are: a) the provision of large collection of high quality copyright-free images; b) the formulation of the Ontology of visual objects based on WordNet noun hierarchies; c) the precise manual correction of automatic object segmentation within the images and the annotation of object classes; and d) the association of objects and images with extended multilingual descriptions based on WordNet inner- and interlingual relations. The dataset can be used also for multilingual image caption generation, image-to-text alignment and automatic question answering for images and videos.
 
 
+## This Hugging Face dataset
+
+The original data can be found via the link below.  
+The present dataset converts the original data into a Hugging Face dataset.
+We have in particular:  
+- convert everything in parquet,
+- convert image as PIL,
+- create one column per language.
+
+## Usage
+
+Since the global dataset is just about 70GB, we have chosen to present it as 4 splits so that users can use the one of their choice if they don’t need all of it.
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("FrancophonIA/MIC21", "arts")
+ds = load_dataset("FrancophonIA/MIC21", "sport")
+ds = load_dataset("FrancophonIA/MIC21", "security")
+ds = load_dataset("FrancophonIA/MIC21", "transport")
+```
+
+## Configs
+
+| Config | Content |
+|---|---|
+| `arts` | Artists, musicians, dancers, sculptors... |
+| `security` | Security personnel, equipment... |
+| `sport` | Athletes and sporting activities |
+| `transport` | Vehicles and means of transport |
+
+## Column Schema
+
+| Column | Type | Description |
+|---|---|---|
+| `image` | `Image` | Embedded PIL image (RGB JPEG) |
+| `image_id` | `int64` | Unique image identifier (COCO) |
+| `file_name` | `string` | Source file name |
+| `width` | `int32` | Image width in pixels |
+| `height` | `int32` | Image height in pixels |
+| `domain` | `string` | Domain (`ARTS`, `SECURITY`, `SPORT`, `TRANSPORT`) |
+| `class_name` | `string` | Main class of the image (e.g. `accordionist`) |
+| `label_en` | `string` | English translation of the class |
+| `label_fr` | `string` | French translation of the class |
+| `label_XX` | `string` | Same for all 25 languages (see table below) |
+| `objects` | `list` | List of annotated objects (COCO format, see below) |
+
+### `objects` field
+
+Each entry in the list corresponds to one COCO annotation:
+
+| Field | Type | Description |
+|---|---|---|
+| `annotation_id` | `int64` | Annotation identifier |
+| `category_id` | `int64` | Category identifier |
+| `category_name` | `string` | Category name |
+| `bbox` | `list[float32]` | Bounding box `[x, y, width, height]` (COCO format) |
+| `area` | `float32` | Object area in pixels² |
+| `iscrowd` | `int8` | `1` if dense crowd, `0` otherwise |
+| `segmentation` | `list[list[float32]]` | COCO segmentation polygons |
+| `metadata` | `string` | Additional metadata (serialized JSON) |
+
+### Available languages (`label_XX`)
+
+| Code | Language | Code | Language | Code | Language |
+|---|---|---|---|---|---|
+| `en` | English | `fr` | French | `de` | German |
+| `es` | Spanish | `it` | Italian | `pt` | Portuguese |
+| `nl` | Dutch | `pl` | Polish | `ru` | Russian |
+| `bg` | Bulgarian | `sr` | Serbian | `hr` | Croatian |
+| `sk` | Slovak | `sl` | Slovenian | `ro` | Romanian |
+| `el` | Greek | `ca` | Catalan | `gl` | Galician |
+| `eu` | Basque | `sq` | Albanian | `fi` | Finnish |
+| `sv` | Swedish | `da` | Danish | `lt` | Lithuanian |
+| `is` | Icelandic | | | | |
+
 ## Citation
 ```
 @inproceedings{koeva-etal-2022-multilingual,