Upload README.md with huggingface_hub

README.md

@@ -1,39 +1,132 @@
----
-dataset_info:
-  features:
-  - name: tweet_id
-    dtype: string
-  - name: label
-    dtype:
-      class_label:
-        names:
-          '0': QADI_train_ids_QA
-          '1': QADI_train_ids_YE
-          '2': QADI_train_ids_BH
-          '3': QADI_train_ids_IQ
-          '4': QADI_train_ids_KW
-          '5': QADI_train_ids_AE
-          '6': QADI_train_ids_MA
-          '7': QADI_train_ids_DZ
-          '8': QADI_train_ids_SY
-          '9': QADI_train_ids_LY
-          '10': QADI_train_ids_JO
-          '11': QADI_train_ids_LB
-          '12': QADI_train_ids_OM
-          '13': QADI_train_ids_EG
-          '14': QADI_train_ids_TN
-          '15': QADI_train_ids_SA
-          '16': QADI_train_ids_SD
-          '17': QADI_train_ids_PL
-  splits:
-  - name: train
-    num_bytes: 16536918
-    num_examples: 540590
-  download_size: 9550879
-  dataset_size: 16536918
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Dataset Card for QADI
+
+## 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
+
+- **Homepage: [info]**
+- **Repository: [info]**
+- **Paper: [info]**
+- **Leaderboard: [info]**
+- **Point of Contact: [info]**
+
+### Dataset Summary
+
+[More Information Needed]
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+[More Information Needed]
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+[More Information Needed]
+
+## 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]
+
+### Citation Information
+
+```
+@INPROCEEDINGS{hsajjad2020arabench,
+author={Sajjad, Hassan and Abdelali, Ahmed and Durrani, Nadir and Dalvi, Fahim},
+booktitle={GOLING},
+title={AraBench: Benchmarking Dialectal Arabic-English Machine Translation},
+year={2020},
+month={Dec},
+pages={123-456},
+doi={doi:00000-0000}
+}
+``` 
+
+### Contributions
+
+Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.