Add dataset card

README.md

@@ -1,78 +1,190 @@
 ---
+annotations_creators:
+- derived
 language:
-- de
-multilinguality:
-- monolingual
+- deu
+license: mit
+multilinguality: monolingual
 task_categories:
 - text-retrieval
-source_datasets:
-- https://github.com/lavis-nlp/GerDaLIR
 task_ids:
-- document-retrieval
+- Article retrieval
 config_names:
 - corpus
 tags:
-- text-retrieval
+- mteb
+- text
 dataset_info:
-  - config_name: default
-    features:
-      - name: query-id
-        dtype: string
-      - name: corpus-id
-        dtype: string
-      - name: score
-        dtype: float64
-    splits:
-      - name: test
-        num_examples: 14320
-  - config_name: corpus
-    features:
-      - name: _id
-        dtype: string
-      - name: title
-        dtype: string
-      - name: text
-        dtype: string
-    splits:
-      - name: corpus
-        num_examples: 9969
-  - config_name: queries
-    features:
-      - name: _id
-        dtype: string
-      - name: text
-        dtype: string
-    splits:
-      - name: queries
-        num_examples: 12234
+- config_name: default
+  features:
+  - name: query-id
+    dtype: string
+  - name: corpus-id
+    dtype: string
+  - name: score
+    dtype: float64
+  splits:
+  - name: test
+    num_examples: 14320
+- config_name: corpus
+  features:
+  - name: _id
+    dtype: string
+  - name: title
+    dtype: string
+  - name: text
+    dtype: string
+  splits:
+  - name: corpus
+    num_examples: 9969
+- config_name: queries
+  features:
+  - name: _id
+    dtype: string
+  - name: text
+    dtype: string
+  splits:
+  - name: queries
+    num_examples: 12234
 configs:
-  - config_name: default
-    data_files:
-      - split: test
-        path: qrels/test.jsonl
-  - config_name: corpus
-    data_files:
-      - split: corpus
-        path: corpus.jsonl
-  - config_name: queries
-    data_files:
-      - split: queries
-        path: queries.jsonl
+- config_name: default
+  data_files:
+  - split: test
+    path: qrels/test.jsonl
+- config_name: corpus
+  data_files:
+  - split: corpus
+    path: corpus.jsonl
+- config_name: queries
+  data_files:
+  - split: queries
+    path: queries.jsonl
 ---
+<!-- adapted from https://github.com/huggingface/huggingface_hub/blob/v0.30.2/src/huggingface_hub/templates/datasetcard_template.md -->
+
+<div align="center" style="padding: 40px 20px; background-color: white; border-radius: 12px; box-shadow: 0 2px 10px rgba(0, 0, 0, 0.05); max-width: 600px; margin: 0 auto;">
+  <h1 style="font-size: 3.5rem; color: #1a1a1a; margin: 0 0 20px 0; letter-spacing: 2px; font-weight: 700;">GerDaLIRSmall</h1>
+  <div style="font-size: 1.5rem; color: #4a4a4a; margin-bottom: 5px; font-weight: 300;">An <a href="https://github.com/embeddings-benchmark/mteb" style="color: #2c5282; font-weight: 600; text-decoration: none;" onmouseover="this.style.textDecoration='underline'" onmouseout="this.style.textDecoration='none'">MTEB</a> dataset</div>
+  <div style="font-size: 0.9rem; color: #2c5282; margin-top: 10px;">Massive Text Embedding Benchmark</div>
+</div>
+
+The dataset consists of documents, passages and relevance labels in German. In contrast to the original dataset, only documents that have corresponding queries in the query set are chosen to create a smaller corpus for evaluation purposes.
+
+|               |                                             |
+|---------------|---------------------------------------------|
+| Task category | t2t                              |
+| Domains       | Legal, Written                               |
+| Reference     | https://github.com/lavis-nlp/GerDaLIR |
+
+
+## How to evaluate on this task
+
+You can evaluate an embedding model on this dataset using the following code:
+
+```python
+import mteb
+
+task = mteb.get_tasks(["GerDaLIRSmall"])
+evaluator = mteb.MTEB(task)
+
+model = mteb.get_model(YOUR_MODEL)
+evaluator.run(model)
+```
+
+<!-- Datasets want link to arxiv in readme to autolink dataset with paper -->
+To learn more about how to run models on `mteb` task check out the [GitHub repitory](https://github.com/embeddings-benchmark/mteb). 
+
+## Citation
 
-**GerDaLIRSmall**
+If you use this dataset, please cite the dataset as well as [mteb](https://github.com/embeddings-benchmark/mteb), as this dataset likely includes additional processing as a part of the [MMTEB Contribution](https://github.com/embeddings-benchmark/mteb/tree/main/docs/mmteb).
 
-- Original link: https://github.com/lavis-nlp/GerDaLIR
-- The dataset consists of documents, passages and relevance labels in German.
-- The corpus set consists of a collection of legal documents. In contrast to the original dataset, only documents that have corresponding queries in the query set are chosen to create a smaller corpus for evaluation purposes.
-- The query set comprises passages that refer to one or more documents within the corpus set.
+```bibtex
 
-**Usage**
+@inproceedings{wrzalik-krechel-2021-gerdalir,
+  abstract = {We present GerDaLIR, a German Dataset for Legal Information Retrieval based on case documents from the open legal information platform Open Legal Data. The dataset consists of 123K queries, each labelled with at least one relevant document in a collection of 131K case documents. We conduct several baseline experiments including BM25 and a state-of-the-art neural re-ranker. With our dataset, we aim to provide a standardized benchmark for German LIR and promote open research in this area. Beyond that, our dataset comprises sufficient training data to be used as a downstream task for German or multilingual language models.},
+  address = {Punta Cana, Dominican Republic},
+  author = {Wrzalik, Marco  and
+Krechel, Dirk},
+  booktitle = {Proceedings of the Natural Legal Language Processing Workshop 2021},
+  month = nov,
+  pages = {123--128},
+  publisher = {Association for Computational Linguistics},
+  title = {{G}er{D}a{LIR}: A {G}erman Dataset for Legal Information Retrieval},
+  url = {https://aclanthology.org/2021.nllp-1.13},
+  year = {2021},
+}
+
+
+@article{enevoldsen2025mmtebmassivemultilingualtext,
+  title={MMTEB: Massive Multilingual Text Embedding Benchmark},
+  author={Kenneth Enevoldsen and Isaac Chung and Imene Kerboua and Márton Kardos and Ashwin Mathur and David Stap and Jay Gala and Wissam Siblini and Dominik Krzemiński and Genta Indra Winata and Saba Sturua and Saiteja Utpala and Mathieu Ciancone and Marion Schaeffer and Gabriel Sequeira and Diganta Misra and Shreeya Dhakal and Jonathan Rystrøm and Roman Solomatin and Ömer Çağatan and Akash Kundu and Martin Bernstorff and Shitao Xiao and Akshita Sukhlecha and Bhavish Pahwa and Rafał Poświata and Kranthi Kiran GV and Shawon Ashraf and Daniel Auras and Björn Plüster and Jan Philipp Harries and Loïc Magne and Isabelle Mohr and Mariya Hendriksen and Dawei Zhu and Hippolyte Gisserot-Boukhlef and Tom Aarsen and Jan Kostkan and Konrad Wojtasik and Taemin Lee and Marek Šuppa and Crystina Zhang and Roberta Rocca and Mohammed Hamdy and Andrianos Michail and John Yang and Manuel Faysse and Aleksei Vatolin and Nandan Thakur and Manan Dey and Dipam Vasani and Pranjal Chitale and Simone Tedeschi and Nguyen Tai and Artem Snegirev and Michael Günther and Mengzhou Xia and Weijia Shi and Xing Han Lù and Jordan Clive and Gayatri Krishnakumar and Anna Maksimova and Silvan Wehrli and Maria Tikhonova and Henil Panchal and Aleksandr Abramov and Malte Ostendorff and Zheng Liu and Simon Clematide and Lester James Miranda and Alena Fenogenova and Guangyu Song and Ruqiya Bin Safi and Wen-Ding Li and Alessia Borghini and Federico Cassano and Hongjin Su and Jimmy Lin and Howard Yen and Lasse Hansen and Sara Hooker and Chenghao Xiao and Vaibhav Adlakha and Orion Weller and Siva Reddy and Niklas Muennighoff},
+  publisher = {arXiv},
+  journal={arXiv preprint arXiv:2502.13595},
+  year={2025},
+  url={https://arxiv.org/abs/2502.13595},
+  doi = {10.48550/arXiv.2502.13595},
+}
+
+@article{muennighoff2022mteb,
+  author = {Muennighoff, Niklas and Tazi, Nouamane and Magne, Lo{\"\i}c and Reimers, Nils},
+  title = {MTEB: Massive Text Embedding Benchmark},
+  publisher = {arXiv},
+  journal={arXiv preprint arXiv:2210.07316},
+  year = {2022}
+  url = {https://arxiv.org/abs/2210.07316},
+  doi = {10.48550/ARXIV.2210.07316},
+}
 ```
-import datasets
 
-# Download the dataset
-queries = datasets.load_dataset("mteb/GerDaLIRSmall", "queries")
-documents = datasets.load_dataset("mteb/GerDaLIRSmall", "corpus")
-pair_labels = datasets.load_dataset("mteb/GerDaLIRSmall", "default")
-```
+# Dataset Statistics
+<details>
+  <summary> Dataset Statistics</summary>
+
+The following code contains the descriptive statistics from the task. These can also be obtained using:
+
+```python
+import mteb
+
+task = mteb.get_task("GerDaLIRSmall")
+
+desc_stats = task.metadata.descriptive_stats
+```
+
+```json
+{
+    "test": {
+        "num_samples": 22203,
+        "number_of_characters": 209081381,
+        "num_documents": 9969,
+        "min_document_length": 151,
+        "average_document_length": 19707.823653325308,
+        "max_document_length": 427235,
+        "unique_documents": 9969,
+        "num_queries": 12234,
+        "min_query_length": 150,
+        "average_query_length": 1031.0680889324833,
+        "max_query_length": 23560,
+        "unique_queries": 12234,
+        "none_queries": 0,
+        "num_relevant_docs": 14320,
+        "min_relevant_docs_per_query": 1,
+        "average_relevant_docs_per_query": 1.1705084191597188,
+        "max_relevant_docs_per_query": 9,
+        "unique_relevant_docs": 9969,
+        "num_instructions": null,
+        "min_instruction_length": null,
+        "average_instruction_length": null,
+        "max_instruction_length": null,
+        "unique_instructions": null,
+        "num_top_ranked": null,
+        "min_top_ranked_per_query": null,
+        "average_top_ranked_per_query": null,
+        "max_top_ranked_per_query": null
+    }
+}
+```
+
+</details>
+
+---
+*This dataset card was automatically generated using [MTEB](https://github.com/embeddings-benchmark/mteb)*