Update README.md

README.md

@@ -1,40 +1,148 @@
-<br />
-<div align="center">
-    <h2 align="center">AskDocs: A medical QA dataset</h2>
-    <img src="https://images.emojiterra.com/google/noto-emoji/v2.034/512px/1fa7a.png" alt="https://en.wikipedia.org/wiki/Stethoscope" width="250">
-    <br />
-  <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ju-resplande/askD">
-  <img alt="GitHub" src="https://img.shields.io/github/license/ju-resplande/askD">
-  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/ju-resplande/askD?style=social">
-  <p align="center">
-  <b>
-    <a href="https://huggingface.co/datasets/eli5">ELI5 dataset</a> adapted on <a href="https://www.reddit.com/r/AskDocs/">Medical Questions (AskDocs)</a> subreddit.
-  </b>
-  </p>
-</div>
-
-## Getting Started
-
- | Languages | Splits|
-| --- | --- |
-| en  | train_en, validation_en, test_en, external_en |
-| pt  | train_pt, validation_pt, test_pt, external_pt |
+---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+- machine-generated
+languages:
+- en, pt
+licenses:
+- lgpl-3.0
+multilinguality:
+- multilingual
+- translation
+pretty_name: AskDocs
+size_categories:
+- 100K<n<1M
+source_datasets:
+- extended|eli5
+task_categories:
+  - abstractive-qa
+  - open-domain-abstrative-qa
+task_ids:
+  - text2text-generation
+---
 
+# Dataset Card for askD
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Repository:** https://github.com/ju-resplande/askD
+- **Paper:**
+- **Leaderboard:**
+- **Point of Contact:**
+
+### Dataset Summary
+
+[ELI5 dataset](https://huggingface.co/datasets/eli5) adapted on [Medical Questions (AskDocs)](https://www.reddit.com/r/AskDocs/) subreddit.
 We additionally translated to Portuguese and used <a href="https://github.com/LasseRegin/medical-question-answer-data"> external data from here<a>.
-External data are from binary classification dataset "a QNLI medical-like", we adapted to value 5 or 0.
 
-### Usage
+### Supported Tasks and Leaderboards
 
-#### Datasets :hugs
+[More Information Needed]
 
-```python
-from datasets import load_dataset
+### Languages
 
-data = load_dataset("ju-resplande/askD", "train_pt")
-# ['train_en', 'validation_en', 'test_en', 'external_en', 'train_pt', 'validation_pt', 'test_pt', 'external_pt']
-```
+The language data in AskD is English (BCP-47 en) and Brazilian Portuguese (BCP-47 pt-BR) 
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+|                             | Train  | Valid | Test | External |
+| -----                       | ------ | ----- | ---- | -------- |
+| en                          | 24256  |  5198 | 5198 | 166804   |
+| pt                          | 24256  |  5198 | 5198 | 166804   |
+ 
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### 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
+
+[More Information Needed]
 
-## Citing
+### Citation Information
 
 ```bibtex
 @misc{Gomes20202,
@@ -48,6 +156,6 @@ data = load_dataset("ju-resplande/askD", "train_pt")
 }
 ```
 
-## Acknowledgments
+### Contributions
 
-[@viniciusplo](https://github.com/viniciusplo) and [@ruanchaves](https://github.com/ruanchaves) for giving the idea. :smiley:
+Thanks to [@ju-resplande](https://github.com/ju-resplande) for adding this dataset.