Update README.md

README.md

@@ -29,3 +29,95 @@ configs:
   - split: test
     path: data/test-*
 ---
+
+
+Created from the three datasets `wikiann`, `norne`, `dane`, and `KBLab/sucx3_ner`. 
+
+See detailed config below:
+
+```python
+dataset_ids = [
+    "wikiann",
+    "dane",
+    "norne", 
+    "KBLab/sucx3_ner"
+]
+
+dataset_subsets = {
+    "wikiann": [
+        "nn", "no", "da", "sv", "fo", "is"
+    ],
+    "dane": [None],
+    "norne": ["combined-7"],
+    "KBLab/sucx3_ner": ["original_cased"]
+}
+```
+
+Unified to the following BIO-scheme:
+
+
+```
+# O: 0
+# B-PER: 1
+# I-PER: 2
+# B-ORG: 3
+# I-ORG: 4
+# B-LOC: 5
+# I-LOC: 6
+# B-MISC: 7
+# I-MISC: 8
+
+mappers = {
+    "norne": {
+        0: 0,
+        1: 1,
+        2: 2,
+        3: 3,
+        4: 4,
+        # PROD->MISC
+        5: 7,
+        6: 8,
+        # LOC -> LOC
+        7: 5,
+        8: 6,
+        # DRV -> MISC (names, but derived)
+        9: 7,
+        10: 8,
+        # EVT -> MISC (events)
+        11: 7,
+        12: 8,
+        # MISC -> MISC
+        13: 7,
+        14: 8,
+    },
+    "KBLab/sucx3_ner": {
+        "O": 0,
+        # PER
+        "B-person": 1,
+        "I-person": 2,
+        # LOC
+        "B-place": 5,
+        "I-place": 6,
+        # ORG
+        "I-inst": 4,
+        "B-inst": 3,
+        # MISC
+        # this is considered a 'work' by someone or something
+        "B-work": 7,
+        "I-work": 8,
+        "B-animal": 7,
+        "I-animal": 8,
+        "B-product": 7,
+        "I-product": 8,
+        "B-event": 7,
+        "I-event": 8,
+        "B-other": 7,
+        "I-other": 8,
+        # mythological
+        "B-myth": 7,
+        "I-myth": 8,
+    },
+}
+
+
+```