Upload README.md with huggingface_hub

README.md

@@ -1,33 +1,51 @@
 ---
-dataset_info:
-  features:
-  - name: tokens
-    sequence: string
-  - name: ner_tags_niv1
-    sequence: string
-  - name: ner_tags_niv2
-    sequence: string
-  - name: input_ids
-    sequence: int32
-  - name: attention_mask
-    sequence: int8
-  - name: labels_niv1
-    sequence: int64
-  - name: labels_niv2
-    sequence: int64
-  splits:
-  - name: train
-    num_bytes: 6312919
-    num_examples: 6084
-  - name: dev
-    num_bytes: 691832
-    num_examples: 676
-  - name: test
-    num_bytes: 1683259
-    num_examples: 1685
-  download_size: 1069679
-  dataset_size: 8688010
+language:
+- fr
+multilinguality:
+- monolingual
+task_categories:
+- token-classification
 ---
-# Dataset Card for "m1_qualitative_analysis_ref_cmbert_iob2"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# m1_qualitative_analysis_ref_cmbert_iob2
+
+## Introduction
+
+This dataset was used to perform **qualitative analysis** of [Jean-Baptiste/camembert-ner](https://huggingface.co/Jean-Baptiste/camembert-ner) on **nested NER task** using Independant NER layers approach [M1]. 
+It contains Paris trade directories entries from the 19th century.
+
+## Dataset parameters
+
+* Approach : M1
+* Dataset type : ground-truth
+* Tokenizer : [Jean-Baptiste/camembert-ner](https://huggingface.co/Jean-Baptiste/camembert-ner)
+* Tagging format : IOB2
+* Counts : 
+    * Train : 6084
+    * Dev : 676
+    * Test : 1685
+* Associated fine-tuned models :
+    * Level-1 : [nlpso/m1_ind_layers_ref_cmbert_iob2_level_1](https://huggingface.co/nlpso/m1_ind_layers_ref_cmbert_iob2_level_1)
+    * Level 2 : [nlpso/m1_ind_layers_ref_cmbert_iob2_level_2](https://huggingface.co/nlpso/m1_ind_layers_ref_cmbert_iob2_level_2)
+    
+## Entity types
+
+Abbreviation|Entity group (level)|Description
+-|-|-
+O |1 & 2|Outside of a named entity
+PER |1|Person or company name
+ACT |1 & 2|Person or company professional activity
+TITREH |2|Military or civil distinction
+DESC |1|Entry full description
+TITREP |2|Professionnal reward
+SPAT |1|Address
+LOC |2|Street name
+CARDINAL |2|Street number
+FT |2|Geographical feature
+
+## How to use this dataset
+
+```python
+from datasets import load_dataset
+
+train_dev_test = load_dataset("nlpso/m1_qualitative_analysis_ref_cmbert_iob2")