Upload README.md with huggingface_hub

README.md

@@ -1,29 +1,46 @@
 ---
-dataset_info:
-  features:
-  - name: tokens
-    sequence: string
-  - name: ner_tags
-    sequence: string
-  - name: input_ids
-    sequence: int32
-  - name: attention_mask
-    sequence: int8
-  - name: labels
-    sequence: int64
-  splits:
-  - name: train
-    num_bytes: 3246469
-    num_examples: 6084
-  - name: dev
-    num_bytes: 356584
-    num_examples: 676
-  - name: test
-    num_bytes: 866291
-    num_examples: 1685
-  download_size: 879921
-  dataset_size: 4469344
+language:
+- fr
+multilinguality:
+- monolingual
+task_categories:
+- token-classification
 ---
-# Dataset Card for "m0_fine_tuning_ref_cmbert_io"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# m0_fine_tuning_ref_cmbert_io
+
+## Introduction
+
+This dataset was used to fine-tuned [Jean-Baptiste/camembert-ner](https://huggingface.co/Jean-Baptiste/camembert-ner) for **flat NER task** using Flat NER approach [M0]. 
+It contains 19th-century Paris trade directories' entries.
+
+## Dataset parameters
+
+* Approach : M0
+* Dataset type : ground-truth
+* Tokenizer : [Jean-Baptiste/camembert-ner](https://huggingface.co/Jean-Baptiste/camembert-ner)
+* Tagging format : IO
+* Counts : 
+    * Train : 6084
+    * Dev : 676
+    * Test : 1685
+* Associated fine-tuned model : [nlpso/m0_flat_ner_ref_cmbert_io](https://huggingface.co/nlpso/m0_flat_ner_ref_cmbert_io)
+    
+## Entity types
+
+Abbreviation|Description
+-|-
+O |Outside of a named entity
+PER |Person or company name
+ACT |Person or company professional activity
+TITRE |Distinction
+LOC |Street name
+CARDINAL |Street number
+FT |Geographical feature
+
+## How to use this dataset
+
+```python
+from datasets import load_dataset
+
+train_dev_test = load_dataset("nlpso/m0_fine_tuning_ref_cmbert_io")