Update README.md

README.md

@@ -1,43 +1,113 @@
-# Dataset Card for "HeQ_v1"
-
-## Summary
-HeQ is a question answering dataset in Modern Hebrew, consisting of 30,147 questions. It follows the format and crowdsourcing methodology of SQuAD (Stanford Question Answering Dataset) and the original ParaShoot. The dataset includes paragraphs sourced from Hebrew Wikipedia and Geektime, an online Israeli news channel specializing in technology.
-
-## Question Features
-Two types of questions were collected:
-1. Answerable questions (21,784): Questions for which the answer is present in the paragraph.
-2. Unanswerable questions (8,363): Questions related to the paragraph's content, where the paragraph provides a plausible answer, but the answer is not explicitly included.
-
-## Dataset Information
-- **Configurations:**
-  - **default:**
-    - **train:** `data/train-*`
-    - **test:** `data/test-*`
-    - **validation:** `data/validation-*`
-- **Features:**
-  - **ID:** `string`
-  - **Title:** `string`
-  - **Source:** `string`
-  - **Context:** `string`
-  - **Question:** `string`
-  - **Answers:** `string` (Note: Consider representing answers as a complex structure, e.g., a dictionary)
-  - **Is_Impossible:** `bool`
-  - **WH_Question:** `string`
-  - **Question_Quality:** `string`
-- **Splits:**
-  - **train:** 27,142 examples, 39,986,349 bytes
-  - **test:** 1,504 examples, 2,222,603 bytes
-  - **validation:** 1,501 examples, 2,267,582 bytes
-- **Size Categories:** 1K < n < 10K
-- **Download Size:** 20,887,154 bytes
-- **Dataset Size:** 44,476,534 bytes
-- **License:** cc-by-4.0
-- **Task Categories:**
-  - **question-answering**
-- **Language:** Hebrew (he)
-- **Pretty Name:** Hebrew Question Answering Dataset
-
-[More details and full README on GitHub](https://github.com/NNLP-IL/Hebrew-Question-Answering-Dataset)
-
-## Contributions
-Contributions and additional information are welcome. Please refer to the [contribution guidelines](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards).
+---
+# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
+# Doc / guide: https://huggingface.co/docs/hub/datasets-cards
+{}
+
+---
+
+# Dataset Card for HeQ_v1
+
+## Dataset Description
+
+- **Homepage:** [HeQ - Hebrew Question Answering Dataset](https://github.com/NNLP-IL/Hebrew-Question-Answering-Dataset)
+- **Repository:** [GitHub Repository](https://github.com/NNLP-IL/Hebrew-Question-Answering-Dataset)
+- **Paper:** [HeQ: A Dataset for Hebrew Question Answering](https://u.cs.biu.ac.il/~yogo/heq.pdf)
+- **Leaderboard:** N/A
+
+### Dataset Summary
+
+HeQ is a question answering dataset in Modern Hebrew, consisting of 30,147 questions. It follows the format and crowdsourcing methodology of SQuAD and ParaShoot, with paragraphs sourced from Hebrew Wikipedia and Geektime.
+
+### Supported Tasks and Leaderboards
+
+- **Task:** Question Answering
+
+### Languages
+
+- Hebrew (he)
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+- **ID:** `string`
+- **Title:** `string`
+- **Source:** `string`
+- **Context:** `string`
+- **Question:** `string`
+- **Answers:** `string`
+- **Is_Impossible:** `bool`
+- **WH_Question:** `string`
+- **Question_Quality:** `string`
+
+### Data Splits
+
+- **Train:** 27,142 examples
+- **Test:** 1,504 examples
+- **Validation:** 1,501 examples
+
+## Dataset Creation
+
+### Curation Rationale
+
+The dataset was created to provide a resource for question answering research in Hebrew.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+Paragraphs were sourced from Hebrew Wikipedia and Geektime.
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+A team of crowdworkers formulated and answered reading comprehension questions.
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+License: cc-by-4.0
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+Contributions and additional information are welcome.