Add dataset card

README.md

@@ -1,40 +1,168 @@
 ---
+annotations_creators:
+- expert-annotated
+language:
+- eng
+license: cc-by-4.0
+multilinguality: monolingual
+task_categories:
+- text-retrieval
+task_ids:
+- Article retrieval
 dataset_info:
-  - config_name: corpus
-    splits:
-      - name: test
-        num_bytes: 1217200
-        num_examples: 5023
-  - config_name: queries
-    splits:
-      - name: test
-        num_bytes: 74479
-        num_examples: 100
-  - config_name: default
-    splits:
-      - name: test
-        num_bytes: 41770
-        num_examples: 5062
+- config_name: corpus
+  splits:
+  - name: test
+    num_bytes: 1217200
+    num_examples: 5023
+- config_name: queries
+  splits:
+  - name: test
+    num_bytes: 74479
+    num_examples: 100
+- config_name: default
+  splits:
+  - name: test
+    num_bytes: 41770
+    num_examples: 5062
 configs:
-  - config_name: corpus
-    data_files:
-      - split: test
-        path: data/corpus/test-*.parquet
-  - config_name: queries
-    data_files:
-      - split: test
-        path: data/queries/test-*.parquet
-  - config_name: default
-    data_files:
-      - split: test
-        path: data/default/test-*.parquet
+- config_name: corpus
+  data_files:
+  - split: test
+    path: data/corpus/test-*.parquet
+- config_name: queries
+  data_files:
+  - split: test
+    path: data/queries/test-*.parquet
+- config_name: default
+  data_files:
+  - split: test
+    path: data/default/test-*.parquet
+tags:
+- mteb
+- text
 ---
+<!-- adapted from https://github.com/huggingface/huggingface_hub/blob/v0.30.2/src/huggingface_hub/templates/datasetcard_template.md -->
 
-# Dataset Card for BIRCO-Relic-Test
+<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;">BIRCO-Relic</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>
 
-## Dataset Configurations
+Retrieval task using the RELIC dataset from BIRCO. This dataset contains 100 queries which are excerpts from literary analyses with a missing quotation (indicated by [masked sentence(s)]). Each query has a candidate pool of 50 passages. The objective is to retrieve the passage that best completes the literary analysis.
 
-- **Corpus**: Document collection (5023 documents)
-- **Queries**: Search queries (100 queries)
-- **Default**: Relevance judgments (5062 judgments)
+|               |                                             |
+|---------------|---------------------------------------------|
+| Task category | t2t                              |
+| Domains       | Fiction                               |
+| Reference     | https://github.com/BIRCO-benchmark/BIRCO |
 
+
+## 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(["BIRCO-Relic"])
+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
+
+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).
+
+```bibtex
+
+@misc{wang2024bircobenchmarkinformationretrieval,
+  archiveprefix = {arXiv},
+  author = {Xiaoyue Wang and Jianyou Wang and Weili Cao and Kaicheng Wang and Ramamohan Paturi and Leon Bergen},
+  eprint = {2402.14151},
+  primaryclass = {cs.IR},
+  title = {BIRCO: A Benchmark of Information Retrieval Tasks with Complex Objectives},
+  url = {https://arxiv.org/abs/2402.14151},
+  year = {2024},
+}
+
+
+@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},
+}
+```
+
+# 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("BIRCO-Relic")
+
+desc_stats = task.metadata.descriptive_stats
+```
+
+```json
+{
+    "test": {
+        "num_samples": 5123,
+        "number_of_characters": 2504348,
+        "num_documents": 5023,
+        "min_document_length": 13,
+        "average_document_length": 478.342823014135,
+        "max_document_length": 2579,
+        "unique_documents": 5023,
+        "num_queries": 100,
+        "min_query_length": 588,
+        "average_query_length": 1016.32,
+        "max_query_length": 1472,
+        "unique_queries": 100,
+        "none_queries": 0,
+        "num_relevant_docs": 5062,
+        "min_relevant_docs_per_query": 50,
+        "average_relevant_docs_per_query": 1.0,
+        "max_relevant_docs_per_query": 51,
+        "unique_relevant_docs": 5023,
+        "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)*