upgrade to v3

README.md

@@ -11,42 +11,63 @@ configs:  # Optional. This can be used to pass additional parameters to the data
 - config_name: lb-en
   data_files:
   - split: train
-    path: lb_en.json
+    path: data/v3/lb_en.json
+  default: true   # optional
+
 - config_name: lb-fr
   data_files:
   - split: train
-    path: lb_fr.json
+    path: data/v3/lb_fr.json
 ---
 
 # Dataset Card for LuxAlign
 
-## ⚠️ Update
-We have updated the original dataset ([fredxlpy/LuxAlign_v1](https://huggingface.co/datasets/fredxlpy/LuxAlign_v1)) with the following improvements:
-- **Data Coverage**: Extended to news articles published up to **2nd December 2024** (previously May 10, 2024).
-- **Data Cleaning**: HTML tags that were previously undetected have now been removed.
-- **Sentence Splitting**: Improved sentence tokenizer performance to fix previously incorrect splits.
-- **Placeholder Tags**: Replaced phone numbers, email addresses, and URLs with `[phone]`, `[email]`, and `[url]` tags using regex patterns.
+## Loading the Dataset
+The dataset is currently at **version v3**, which can be loaded as:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("fredxlpy/LuxAlign", name="lb-en")  # or "lb-fr"
+```
+
+If you want to reproduce the results from the paper (`v1`) or use any previous version, you can specify the version folder:
 
+```python
+# Load version v1 (as used in the paper)
+ds_v1 = load_dataset("fredxlpy/LuxAlign", data_dir="data/v1", data_files={"train": "lb_en.json"})
+```
 
 ## Dataset Summary
-LuxAlign is a parallel dataset featuring Luxembourgish-English and Luxembourgish-French sentence pairs, introduced in [*LuxEmbedder: A Cross-Lingual Approach to Enhanced Luxembourgish Sentence Embeddings (Philippy et al., 2024)*](https://doi.org/10.48550/arXiv.2412.03331). Designed to align the Luxembourgish embedding space with those of other languages, it enables improved cross-lingual sentence representations for Luxemborgish. This dataset was used to train the Luxembourgish sentence embedding model [**LuxEmbedder**](https://huggingface.co/fredxlpy/LuxEmbedder). The data originates from news articles published by the Luxembourgish news platform [RTL.lu](https://www.rtl.lu).
+LuxAlign is a parallel dataset featuring Luxembourgish-English and Luxembourgish-French sentence pairs, introduced in [*LuxEmbedder: A Cross-Lingual Approach to Enhanced Luxembourgish Sentence Embeddings* (Philippy et al., 2025)](https://aclanthology.org/2025.coling-main.753/). Designed to align the Luxembourgish embedding space with those of other languages, it enables improved cross-lingual sentence representations for Luxemborgish. This dataset was used to train the Luxembourgish sentence embedding model [**LuxEmbedder**](https://huggingface.co/fredxlpy/LuxEmbedder). The data originates from news articles published by the Luxembourgish news platform [RTL.lu](https://www.rtl.lu).
 
 The sentence pairs in this dataset are not always exact translations but instead reflect high semantic similarity; hence, this dataset may not be suitable for training a machine translation model without caution.
 
 ## Dataset Description
 - **Repository:** [fredxlpy/LuxEmbedder](https://github.com/fredxlpy/LuxEmbedder)
-- **Paper:** [LuxEmbedder: A Cross-Lingual Approach to Enhanced Luxembourgish Sentence Embeddings (Philippy et al., 2024)](https://doi.org/10.48550/arXiv.2412.03331)
+- **Paper:** [LuxEmbedder: A Cross-Lingual Approach to Enhanced Luxembourgish Sentence Embeddings (Philippy et al., COLING 2025)](https://doi.org/10.48550/arXiv.2412.03331)
 
 ## Citation Information
 ```bibtex
-@misc{philippy2024,
-      title={LuxEmbedder: A Cross-Lingual Approach to Enhanced Luxembourgish Sentence Embeddings}, 
-      author={Fred Philippy and Siwen Guo and Jacques Klein and Tegawendé F. Bissyandé},
-      year={2024},
-      eprint={2412.03331},
-      archivePrefix={arXiv},
-      primaryClass={cs.CL},
-      url={https://arxiv.org/abs/2412.03331}, 
+@inproceedings{philippy-etal-2025-luxembedder,
+    title = "{L}ux{E}mbedder: A Cross-Lingual Approach to Enhanced {L}uxembourgish Sentence Embeddings",
+    author = "Philippy, Fred  and
+      Guo, Siwen  and
+      Klein, Jacques  and
+      Bissyande, Tegawende",
+    editor = "Rambow, Owen  and
+      Wanner, Leo  and
+      Apidianaki, Marianna  and
+      Al-Khalifa, Hend  and
+      Eugenio, Barbara Di  and
+      Schockaert, Steven",
+    booktitle = "Proceedings of the 31st International Conference on Computational Linguistics",
+    month = jan,
+    year = "2025",
+    address = "Abu Dhabi, UAE",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2025.coling-main.753/",
+    pages = "11369--11379",
 }
 ```
 

data/v1/lb_en.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:13e37753d5078387e3abfb1af246b5fad244600e977539caf3ece5ec9bb564a3
+size 6757718

data/v1/lb_fr.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fc42c4a8ff862f7fcee3936d48fdd5e0ea02941fbf530fbf1e6ac891d4605eb
+size 22962370

data/v2/README.md

@@ -0,0 +1,6 @@
+# ⚠️ Update
+We have updated the original dataset (`v1`) with the following improvements:
+- **Data Coverage**: Extended to news articles published up to **2nd December 2024** (previously May 10, 2024).
+- **Data Cleaning**: HTML tags that were previously undetected have now been removed.
+- **Sentence Splitting**: Improved sentence tokenizer performance to fix previously incorrect splits.
+- **Placeholder Tags**: Replaced phone numbers, email addresses, and URLs with `[phone]`, `[email]`, and `[url]` tags using regex patterns.

data/v3/lb_en.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ecad076503c46599bebf55a1744031f6d8f34fffbd902f18840cebb9240de0b0
+size 11299023

data/v3/lb_fr.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:18b7739bab45a96c3640a100ad5925f95f0cedc1dc6de435c7ea481a18caf5ac
+size 40386679