Update README.md

README.md

@@ -1,3 +1,159 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+  - en
+pretty_name: Tiny QA Evaluation Dataset
+size_categories:
+  - n<1K
+tags:
+  - question-answering
+  - evaluation
+  - benchmark
+  - toy-dataset
+task_categories:
+  - question-answering
+task_ids:
+  - generative-qa
+  - extractive-qa
+---
+
+# Tiny QA Evaluation Dataset
+
+A very small, general-knowledge QA set (16 examples) for quick sanity checks, pipeline smoke-tests, and demoing LLM evaluation workflows.
+
+## Dataset Summary
+
+This dataset contains 16 question–answer pairs covering geography, history, math, science, literature, and more. Each example includes:
+
+- **text**: the question prompt  
+- **label**: the “gold” answer  
+- **metadata.context**: a one-sentence fact  
+- **tags**: additional annotations (`category`, `difficulty`)
+
+It’s intentionally tiny (≈1 KB, under 1 K examples) so you can iterate on data loading, evaluation scripts, or CI steps in under a second.
+
+## Supported Tasks and Formats
+
+- **Tasks**:  
+  - Extractive QA  
+  - Generative QA  
+- **Format**: JSON  
+- **Splits**:  
+  - `train` (all 52 examples)  
+
+## Languages
+
+- English (`en`)
+
+## Dataset Structure
+
+### Data Fields
+
+Each example in `data/train.json` has:
+
+| field               | type   | description                                  |
+|---------------------|--------|----------------------------------------------|
+| `text`              | string | The question prompt.                         |
+| `label`             | string | The correct answer.                          |
+| `metadata`          | object | Additional info.                             |
+| `metadata.context`  | string | A one-sentence fact supporting the answer.   |
+| `tags.category`     | string | Broad question category (e.g. `geography`).  |
+| `tags.difficulty`   | string | Rough difficulty level (e.g. `easy`).        |
+
+## Data Example
+
+```json
+[
+  {
+    "text": "What is the capital of France?",
+    "label": "Paris",
+    "metadata": {
+      "context": "France is a country in Europe. Its capital is Paris."
+    },
+    "tags": {
+      "category": "geography",
+      "difficulty": "easy"
+    }
+  },
+  {
+    "text": "What is 2 + 2?",
+    "label": "4",
+    "metadata": {
+      "context": "Basic arithmetic: 2 + 2 equals 4."
+    },
+    "tags": {
+      "category": "math",
+      "difficulty": "easy"
+    }
+  },
+```
+
+## Data Splits
+
+Only one split:
+
+- **train**: 52 examples, used for development and quick evaluation.
+
+## Data Creation
+
+### Curation Rationale
+
+“Tiny QA Eval” exists to:
+
+1. Smoke-test QA pipelines (loading, preprocessing, evaluation).  
+2. Demo Hugging Face Datasets integration in tutorials.  
+3. Verify model–eval loops run without downloading large corpora.
+
+### Source Data
+
+Hand-crafted by the dataset creator from well-known, public-domain facts.
+
+### Annotations
+
+Self-annotated. Each `metadata.context` and `tags` field is manually created.
+
+## Usage
+
+Load with:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("vincentkoc/tiny_qa_benchmark")
+print(ds["train"][0])
+# {
+#   "text": "What is the capital of France?",
+#   "label": "Paris",
+#   "metadata": {
+#     "context": "France is a country in Europe. Its capital is Paris."
+#   },
+#   "tags": {
+#     "category": "geography",
+#     "difficulty": "easy"
+#   }
+# }
+```
+
+## Considerations
+
+- **Not a benchmark**: Too few examples for statistical significance.  
+- **Do not train**: Use only for smoke-tests or demos.  
+- **No sensitive data**: All facts are public domain.
+
+## Licensing
+
+Apache-2.0. See [LICENSE](LICENSE) for details.
+
+## Citation
+
+If you use this dataset, please cite:
+
+```bibtex
+@misc{tinyqaeval2025,
+  title        = {Tiny QA Evaluation Dataset},
+  author       = {Vincent Koc},
+  year         = {2025},
+  howpublished = {\url{https://huggingface.co/vincentkoc/tinytest}},
+  license      = {Apache-2.0}
+}
+```