Update README.md

README.md

@@ -1,10 +1,18 @@
-Trained using SimCSE with:
+---
+license: mit
+datasets:
+- DDSC/dagw_no_twitter
+language:
+- da
+tags:
+- SimCSE
+---
+Trained using the [SimCSE](https://github.com/princeton-nlp/SimCSE) implementation with:
 
 ```
 CUDA_VISIBLE_DEVICES=0 python train.py \
-    --train_file data/dfm_paragraphs.txt \
+    --train_file data/dfm_paragraphs.txt \ # paragraphs extract from Danish Gigaword
     --model_name_or_path chcaa/dfm-encoder-large-v1 \
-    --output_dir result/dfm-sentence-encoder-medium-v4 \
     --num_train_epochs 1 \
     --per_device_train_batch_size 128 \
     --learning_rate 1e-5 \
@@ -19,4 +27,26 @@ CUDA_VISIBLE_DEVICES=0 python train.py \
     --temp 0.05 \
     --do_train \
     --fp16 
-```
+```
+
+
+## Citation
+
+To cite this work please refer to the following article:
+
+```
+Enevoldsen, K., Kardos, M., Muennighoff, N., & Nielbo, K. (2024). The Scandinavian Embedding Benchmarks: Comprehensive Assessment of Multilingual and Monolingual Text Embedding. https://openreview.net/forum?id=pJl_i7HIA72
+```
+
+or use the following BibTeX:
+```
+@article{enevoldsenScandinavianEmbeddingBenchmarks2024,
+	title = {The {Scandinavian} {Embedding} {Benchmarks}: {Comprehensive} {Assessment} of {Multilingual} and {Monolingual} {Text} {Embedding}},
+	shorttitle = {The {Scandinavian} {Embedding} {Benchmarks}},
+	url = {https://openreview.net/forum?id=pJl_i7HIA72},
+	language = {en},
+	urldate = {2024-04-12},
+	author = {Enevoldsen, Kenneth and Kardos, Márton and Muennighoff, Niklas and Nielbo, Kristoffer},
+	month = feb,
+	year = {2024},
+}