Update README.md

README.md

@@ -9,4 +9,81 @@ language:
 pretty_name: Norwegian Idioms
 size_categories:
 - 1K<n<10K
----
+license: cc0-1.0
+---
+
+# Norwegian idioms
+
+This is a dataset that consists of 3537 Norwegian idioms and phrases that appear more than 100 times in the [online library](https://www.nb.no/search) of the National Library of Norway.  
+There are 3455 Bokmål idioms and 88 Nynorsk idioms. In the future, we want to add more Nynorsk idioms.
+
+## Idiom completion as an NLP task
+
+
+In `idiom_dataset.json` the idioms are split into idiom starts (the first N-1 words) and accepted completions (a list of possible last words to complete the idiom).  
+
+This dataset can be used to measure a generative language models' ability to complete well known idioms, or as a masked language modelling task. 
+
+It can be loaded as a Datasets dataset like this: 
+```python
+from datasets import Dataset 
+import pandas as pd
+
+df = pd.read_json("idiom_dataset.json")
+ds = Dataset.from_pandas(df)
+```
+The dataset has the columns "idiom_start", "accepted_completions" and "language".  
+There are 3245 rows, 156 of which there are more than one accepted completion.
+
+
+## Idioms
+`all_idioms_freq.json` contain all the idioms and their frequency in the online library as key,value pairs  
+`nno_idioms_freq.json` contain the Nynorsk idioms and their frequency in the online library as key,value pairs  
+`nob_idioms_freq.json` contain the Bokmål idioms and their frequency in the online library as key,value pairs  
+
+
+## Idiom graphs
+There is considerable linguistic overlap between the idioms. For example, though there are 3537 unique idioms, there are only 796 unique starter words.  
+We have arranged the idioms as trees, where the roots are the start words, and the idioms are found by following a path from a start node to a leaf node.  
+Example: 
+```json
+"alt": {
+    "er": {
+        "bare": {
+            "fryd": {
+                "og": {
+                    "gammen": {}
+                }
+            }
+        },
+        "klappet": {
+            "og": {
+                "klart": {}
+            }
+        },
+        "såre": {
+            "vel": {}
+        }
+    },
+    "går": {
+        "sin": {
+            "vante": {
+                "gang": {}
+            }
+        }
+    },
+```
+Here is a tree where "alt" is a root, the idioms "alt er bare fryd og gammen", "alt er klappet og klart", "alt er såre vel" and "alt går sin vante gang" can be found by traversing the tree.  
+These trees can be found at `all_idioms_sequence_graph.json`, `nno_idioms_sequence_graph.json` and `nob_idioms_sequence_graph.json`.  
+
+Flat versions of the trees (where consecutive nodes/words with only one child are merged into word sequences) can be found at `all_idioms_flat_sequence_graph.json`, `nno_idioms_flat_sequence_graph.json` and `nob_idioms_flat_sequence_graph.json`.    
+Example:
+```json
+"alt": {
+    "er": {
+        "bare fryd og gammen": "",
+        "klappet og klart": "",
+        "såre vel": ""
+    },
+    "går sin vante gang": "",
+```