Update README.md

README.md

@@ -151,4 +151,43 @@ configs:
     path: nob_nno/validation-*
   - split: test
     path: nob_nno/test-*
+language:
+- en
+- nb
+- nn
 ---
+
+# Målfrid parallel 
+
+This dataset contains parallel data for the following languages: Norwegian Bokmål, Norwegian Nynorsk, English. 
+
+## Loading datasets
+The dataset is organized by the three language pairs "nob_nno" (Norwegian Bokmål, Norwegian Nynorsk), "nob_eng" (Norwegian Bokmål, English) and "nno_eng" (Norwegian Nynorsk, English).  
+Each division has a train, val, test split, and there is no overlap of source domains between the splits.
+
+Load the dataset you want with the `name` arg like this: 
+```python
+from datasets import load_dataset
+
+ds = load_dataset("NbAiLab/maalfrid_parallel", name="nno_eng")
+
+```
+
+
+## Source data 
+The source data is from the Målfrid project, which involves scraping .no governmental web sites to report language use.  
+We combined the following datasets:
+- Målfrid 2021 [resource catalogue](https://www.nb.no/sprakbanken/ressurskatalog/oai-nb-no-sbr-69/)
+- Målfrid 2022 [resource catalogue](https://www.nb.no/sprakbanken/ressurskatalog/oai-nb-no-sbr-97/)
+- Målfrid 2023 [resource catalogue](https://www.nb.no/sprakbanken/ressurskatalog/oai-nb-no-sbr-98/)
+- Målfrid 2024 [resource catalogue](https://www.nb.no/sprakbanken/ressurskatalog/oai-nb-no-sbr-99/)
+- Målfrid 2025 [resource catalogue](https://www.nb.no/sprakbanken/ressurskatalog/oai-nb-no-sbr-102/)
+
+## Alignment method
+The document pairs were aligned per website with [NbAiLab/nb-sbert-v2-base](https://huggingface.co/NbAiLab/nb-sbert-v2-base) and the sentence-transformers library.  
+For English-Norwegain parallel data, the minimun cosine similarity threshold is 0.80, and for Norwegian parallel data it is 0.95. See [source code](https://github.com/Sprakbanken/alignment_eksperimenter) 
+
+
+
+## Licence
+Norwegian Licence for Open Government Data (NLOD) https://data.norge.no/nlod/en/2.0