Upload README.md with huggingface_hub

README.md

@@ -1,53 +1,134 @@
----
-dataset_info:
-  features:
-  - name: context
-    dtype: string
-  - name: response
-    dtype: string
-  - name: label
-    dtype:
-      class_label:
-        names:
-          '0': afraid
-          '1': surprised
-          '2': embarrassed
-          '3': excited
-          '4': nostalgic
-          '5': trusting
-          '6': terrified
-          '7': furious
-          '8': hopeful
-          '9': disgusted
-          '10': sentimental
-          '11': anxious
-          '12': anticipating
-          '13': prepared
-          '14': guilty
-          '15': annoyed
-          '16': confident
-          '17': sad
-          '18': impressed
-          '19': grateful
-          '20': caring
-          '21': disappointed
-          '22': apprehensive
-          '23': jealous
-          '24': content
-          '25': angry
-          '26': proud
-          '27': devastated
-          '28': faithful
-          '29': ashamed
-          '30': joyful
-          '31': lonely
-  splits:
-  - name: train
-    num_bytes: 8024260
-    num_examples: 36628
-  download_size: 4247519
-  dataset_size: 8024260
----
-# Dataset Card for "arabic_empathetic_conversations"
-
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# Dataset Card for arabic_empathetic_conversations
+
+## 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{naous-etal-2021-empathetic,
+    title = "Empathetic {BERT}2{BERT} Conversational Model: Learning {A}rabic Language Generation with Little Data",
+    author = "Naous, Tarek  and Antoun, Wissam  and Mahmoud, Reem  and Hajj, Hazem",
+    booktitle = "Proceedings of the Sixth Arabic Natural Language Processing Workshop",
+    month = apr,
+    year = "2021",
+    address = "Kyiv, Ukraine (Virtual)",
+    publisher = "Association for Computational Linguistics",
+    url = "https://www.aclweb.org/anthology/2021.wanlp-1.17",
+    pages = "164--172",
+}
+``` 
+
+### Contributions
+
+Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.