docs: add README

README.md

@@ -1,3 +1,105 @@
----
-license: cc-by-sa-4.0
----
+---
+license: cc-by-sa-4.0
+task_categories:
+- text-retrieval
+- question-answering
+- text-ranking
+language:
+- en
+tags:
+- legal
+- law
+- legislative
+size_categories:
+- n<1K
+source_datasets:
+- reglab/housing_qa
+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: 500
+- config_name: corpus
+  features:
+  - name: _id
+    dtype: string
+  - name: title
+    dtype: string
+  - name: text
+    dtype: string
+  splits:
+  - name: corpus
+    num_examples: 373
+- config_name: queries
+  features:
+  - name: _id
+    dtype: string
+  - name: text
+    dtype: string
+  splits:
+  - name: queries
+    num_examples: 92
+configs:
+- config_name: default
+  data_files:
+  - split: test
+    path: data/default.jsonl
+- config_name: corpus
+  data_files:
+  - split: corpus
+    path: data/corpus.jsonl
+- config_name: queries
+  data_files:
+  - split: queries
+    path: data/queries.jsonl
+pretty_name: HousingQA (MTEB format)
+---
+# HousingQA (MTEB format)
+This is the [HousingQA](https://huggingface.co/datasets/reglab/housing_qa) evaluation dataset formatted in the [Massive Text Embedding Benchmark (MTEB)](https://github.com/embeddings-benchmark/mteb) information retrieval dataset format.
+
+This dataset is intended to facilitate the consistent and reproducible evaluation of information retrieval models on HousingQA with the [`mteb`](https://github.com/embeddings-benchmark/mteb) embedding model evaluation framework.
+
+More specifically, this dataset tests the ability of information retrieval models to retrieve relevant legislation to complex, reasoning-intensive legal questions.
+
+This dataset has been processed into the MTEB format by [Isaacus](https://isaacus.com/), a legal AI research company.
+
+## Structure 🗂️
+As per the MTEB information retrieval dataset format, this dataset comprises three splits, `default`, `corpus`, and `queries`.
+
+The `default` split pairs questions (`query-id`) with relevant legislation (`corpus-id`), each pair having a `score` of 1.
+
+The `corpus` split contains legislation, with the text of a law being stored in the `text` key and its id being stored in the `_id` key. There is also a `title` column, which is deliberately set to an empty string in all cases for compatibility with the [`mteb`](https://github.com/embeddings-benchmark/mteb) library.
+
+The `queries` split contains questions, with the text of a question being stored in the `text` key and its id being stored in the `_id` key.
+
+## Methodology 🧪
+To understand how HousingQA itself was created, refer to its [documentation](https://huggingface.co/datasets/reglab/housing_qa).
+
+This dataset was formatted by taking the test split of HousingQA and treating questions as anchors and relevant legislation as positive passages. 500 examples were randomly sampled in order to keep the size of this dataset manageable.
+
+## License 📜
+To the extent that any intellectual property rights reside in the contributions made by Isaacus in formatting and processing this dataset, Isaacus licenses those contributions under the same license terms as the source dataset. You are free to use this dataset without citing Isaacus.
+
+The source dataset is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
+
+## Citation 🔖
+```bibtex
+@inproceedings{Zheng_2025, series={CSLAW ’25},
+   title={A Reasoning-Focused Legal Retrieval Benchmark},
+   url={http://dx.doi.org/10.1145/3709025.3712219},
+   DOI={10.1145/3709025.3712219},
+   eprint={10.1145/3709025.3712219},
+   booktitle={Proceedings of the Symposium on Computer Science and Law},
+   publisher={ACM},
+   author={Zheng, Lucia and Guha, Neel and Arifov, Javokhir and Zhang, Sarah and Skreta, Michal and Manning, Christopher D. and Henderson, Peter and Ho, Daniel E.},
+   year={2025},
+   month=mar, pages={169–193},
+   collection={CSLAW ’25} }
+```