Add dataset README

README.md

@@ -1,102 +1,138 @@
 ---
-dataset_info:
-- config_name: answers
-  features:
-  - name: query_id
-    dtype: string
-  - name: answer
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 2819282
-    num_examples: 32747
-  - name: dev
-    num_bytes: 296566
-    num_examples: 3461
-  - name: test
-    num_bytes: 912283
-    num_examples: 10557
-  download_size: 1741986
-  dataset_size: 4028131
-- config_name: corpus
-  features:
-  - name: id
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5422604
-    num_examples: 1572
-  download_size: 3371037
-  dataset_size: 5422604
-- config_name: qrels
-  features:
-  - name: query_id
-    dtype: string
-  - name: corpus_id
-    dtype: string
-  - name: score
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 3438435
-    num_examples: 32747
-  - name: dev
-    num_bytes: 363405
-    num_examples: 3461
-  - name: test
-    num_bytes: 1108485
-    num_examples: 10557
-  download_size: 769624
-  dataset_size: 4910325
-- config_name: queries
-  features:
-  - name: id
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3417437
-    num_examples: 32747
-  - name: dev
-    num_bytes: 359091
-    num_examples: 3461
-  - name: test
-    num_bytes: 1105671
-    num_examples: 10557
-  download_size: 2031982
-  dataset_size: 4882199
+license: apache-2.0
+task_categories:
+  - question-answering
+  - text-retrieval
+language:
+  - en
+tags:
+  - rag
+  - narrativeqa
+  - reading-comprehension
+  - retrieval
+size_categories:
+  - 10K<n<100K
 configs:
-- config_name: answers
-  data_files:
-  - split: train
-    path: answers/train-*
-  - split: dev
-    path: answers/dev-*
-  - split: test
-    path: answers/test-*
-- config_name: corpus
-  data_files:
-  - split: train
-    path: corpus/train-*
-- config_name: qrels
-  data_files:
-  - split: train
-    path: qrels/train-*
-  - split: dev
-    path: qrels/dev-*
-  - split: test
-    path: qrels/test-*
-- config_name: queries
-  data_files:
-  - split: train
-    path: queries/train-*
-  - split: dev
-    path: queries/dev-*
-  - split: test
-    path: queries/test-*
+  - config_name: corpus
+    data_files:
+      - split: train
+        path: corpus/*
+  - config_name: queries
+    data_files:
+      - split: train
+        path: queries/train*
+      - split: dev
+        path: queries/dev*
+      - split: test
+        path: queries/test*
+  - config_name: qrels
+    data_files:
+      - split: train
+        path: qrels/train*
+      - split: dev
+        path: qrels/dev*
+      - split: test
+        path: qrels/test*
+  - config_name: answers
+    data_files:
+      - split: train
+        path: answers/train*
+      - split: dev
+        path: answers/dev*
+      - split: test
+        path: answers/test*
 ---
+
+# NarrativeQA RAG
+
+Dataset for Retrieval-Augmented Generation (RAG) based on [NarrativeQA](https://huggingface.co/datasets/deepmind/narrativeqa).
+
+## Structure
+
+| Subset | Splits | Description |
+|--------|--------|-------------|
+| `corpus` | train (default) | Wikipedia plot summaries shared across all query splits |
+| `queries` | train, dev, test | Reading comprehension questions |
+| `qrels` | train, dev, test | Relevance judgments (query ↔ document) |
+| `answers` | train, dev, test | Reference answers (longest annotated answer) |
+
+## Dataset statistics
+
+| Split | Queries | Corpus |
+|-------|--------:|-------:|
+| train | 32747 | 1572 |
+| dev   | 3461 | 1572 |
+| test  | 10557 | 1572 |
+
+The corpus is shared across all splits and contains Wikipedia plot summaries (`document.summary.text`) from the original NarrativeQA documents.
+
+- **Dev split:** mapped from the original `validation` split
+- **Corpus source:** unique documents from train, validation and test splits
+
+## Source
+
+| Component | NarrativeQA resource |
+|-----------|----------------------|
+| Train | `train` split from [deepmind/narrativeqa](https://huggingface.co/datasets/deepmind/narrativeqa) |
+| Dev | `validation` split |
+| Test | `test` split |
+| Corpus | `document.summary.text` (+ `document.summary.title`) |
+| Answers | Longest answer text per question |
+
+## Schema
+
+### corpus
+```json
+{"id": "...", "title": "...", "text": "..."}
+```
+
+### queries
+```json
+{"id": "...", "text": "..."}
+```
+
+### qrels
+```json
+{"query_id": "...", "corpus_id": "...", "score": 1}
+```
+
+### answers
+```json
+{"query_id": "...", "answer": "..."}
+```
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+corpus = load_dataset("DinoStackAI/narrativeqa-rag", "corpus")["train"]
+queries = load_dataset("DinoStackAI/narrativeqa-rag", "queries")
+qrels = load_dataset("DinoStackAI/narrativeqa-rag", "qrels")
+answers = load_dataset("DinoStackAI/narrativeqa-rag", "answers")
+
+train_queries = queries["train"]
+dev_qrels = qrels["dev"]
+test_answers = answers["test"]
+```
+
+## Citation
+
+NarrativeQA is released under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+```bibtex
+@article{kocisky-etal-2018-narrativeqa,
+    title = "The {N}arrative{QA} Reading Comprehension Challenge",
+    author = "Ko{\v{c}}isk{\'y}, Tom{\'a}{\v{s}}  and
+      Schwarz, Jonathan  and
+      Blunsom, Phil  and
+      Dyer, Chris  and
+      Hermann, Karl Moritz  and
+      Melis, G{\'a}bor  and
+      Grefenstette, Edward",
+    journal = "Transactions of the Association for Computational Linguistics",
+    volume = "6",
+    year = "2018",
+    pages = "317--328",
+}
+```