Upload README.md with huggingface_hub

README.md

@@ -1,49 +1,129 @@
----
-dataset_info:
-  features:
-  - name: ID
-    dtype: string
-  - name: ROOT
-    dtype: string
-  - name: ROOT_NTWS
-    dtype: string
-  - name: ROOT_1
-    dtype: string
-  - name: LEMMA
-    dtype: string
-  - name: LEMMA_SEARCH
-    dtype: string
-  - name: FORM
-    dtype: string
-  - name: LEMMA_BW
-    dtype: string
-  - name: FORM_BW
-    dtype: string
-  - name: CAPHI++
-    dtype: string
-  - name: ANALYSIS
-    dtype: string
-  - name: GLOSS
-    dtype: string
-  - name: GLOSS_MSA
-    dtype: string
-  - name: EXAMPLE_USAGE
-    dtype: string
-  - name: NOTES
-    dtype: string
-  - name: SOURCE
-    dtype: string
-  - name: ANNOTATOR
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 9623584
-    num_examples: 36302
-  download_size: 3527916
-  dataset_size: 9623584
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Dataset Card for Maknuune
+
+## 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
+
+```
+@article{dibas2022maknuune,
+  title={Maknuune: A Large Open Palestinian Arabic Lexicon},
+  author={Dibas, Shahd and Khairallah, Christian and Habash, Nizar and Sadi, Omar Fayez and Sairafy, Tariq and Sarabta, Karmel and Ardah, Abrar},
+  journal={arXiv preprint arXiv:2210.12985},
+  year={2022}
+}
+``` 
+
+### Contributions
+
+Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.