Upload README.md with huggingface_hub

README.md

@@ -1,215 +1,130 @@
----
-dataset_info:
-  features:
-  - name: HIT_info
-    dtype: string
-  - name: HIT-ID
-    dtype: string
-  - name: AID
-    dtype: string
-  - name: AssignmentID
-    dtype: string
-  - name: HITStatus
-    dtype: string
-  - name: WorkerIP
-    dtype: string
-  - name: WorkerCountry
-    dtype: string
-  - name: WorkerCity
-    dtype: string
-  - name: country_live
-    dtype: string
-  - name: native_arabic
-    dtype: string
-  - name: native_dialect
-    dtype: string
-  - name: years_speaking
-    dtype: string
-  - name: StartTime_str
-    dtype: string
-  - name: EndTime_str
-    dtype: string
-  - name: WorkTime
-    dtype: string
-  - name: comment
-    dtype: string
-  - name: Sentence1
-    dtype: string
-  - name: DClass1
-    dtype: string
-  - name: DLevel1
-    dtype: string
-  - name: source1
-    dtype: string
-  - name: document1
-    dtype: string
-  - name: part1
-    dtype: string
-  - name: segment1
-    dtype: string
-  - name: Sentence2
-    dtype: string
-  - name: DClass2
-    dtype: string
-  - name: DLevel2
-    dtype: string
-  - name: source2
-    dtype: string
-  - name: document2
-    dtype: string
-  - name: part2
-    dtype: string
-  - name: segment2
-    dtype: string
-  - name: Sentence3
-    dtype: string
-  - name: DClass3
-    dtype: string
-  - name: DLevel3
-    dtype: string
-  - name: source3
-    dtype: string
-  - name: document3
-    dtype: string
-  - name: part3
-    dtype: string
-  - name: segment3
-    dtype: string
-  - name: Sentence4
-    dtype: string
-  - name: DClass4
-    dtype: string
-  - name: DLevel4
-    dtype: string
-  - name: source4
-    dtype: string
-  - name: document4
-    dtype: string
-  - name: part4
-    dtype: string
-  - name: segment4
-    dtype: string
-  - name: Sentence5
-    dtype: string
-  - name: DClass5
-    dtype: string
-  - name: DLevel5
-    dtype: string
-  - name: source5
-    dtype: string
-  - name: document5
-    dtype: string
-  - name: part5
-    dtype: string
-  - name: segment5
-    dtype: string
-  - name: Sentence6
-    dtype: string
-  - name: DClass6
-    dtype: string
-  - name: DLevel6
-    dtype: string
-  - name: source6
-    dtype: string
-  - name: document6
-    dtype: string
-  - name: part6
-    dtype: string
-  - name: segment6
-    dtype: string
-  - name: Sentence7
-    dtype: string
-  - name: DClass7
-    dtype: string
-  - name: DLevel7
-    dtype: string
-  - name: source7
-    dtype: string
-  - name: document7
-    dtype: string
-  - name: part7
-    dtype: string
-  - name: segment7
-    dtype: string
-  - name: Sentence8
-    dtype: string
-  - name: DClass8
-    dtype: string
-  - name: DLevel8
-    dtype: string
-  - name: source8
-    dtype: string
-  - name: document8
-    dtype: string
-  - name: part8
-    dtype: string
-  - name: segment8
-    dtype: string
-  - name: Sentence9
-    dtype: string
-  - name: DClass9
-    dtype: string
-  - name: DLevel9
-    dtype: string
-  - name: source9
-    dtype: string
-  - name: document9
-    dtype: string
-  - name: part9
-    dtype: string
-  - name: segment9
-    dtype: string
-  - name: Sentence10
-    dtype: string
-  - name: DClass10
-    dtype: string
-  - name: DLevel10
-    dtype: string
-  - name: source10
-    dtype: string
-  - name: document10
-    dtype: string
-  - name: part10
-    dtype: string
-  - name: segment10
-    dtype: string
-  - name: Sentence11
-    dtype: string
-  - name: DClass11
-    dtype: string
-  - name: DLevel11
-    dtype: string
-  - name: source11
-    dtype: string
-  - name: document11
-    dtype: string
-  - name: part11
-    dtype: string
-  - name: segment11
-    dtype: string
-  - name: Sentence12
-    dtype: string
-  - name: DClass12
-    dtype: string
-  - name: DLevel12
-    dtype: string
-  - name: source12
-    dtype: string
-  - name: document12
-    dtype: string
-  - name: part12
-    dtype: string
-  - name: segment12
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 113250011
-    num_examples: 33093
-  download_size: 22204792
-  dataset_size: 113250011
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Dataset Card for annotated_aoc
+
+## 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{zaidan2011arabic,
+  title={The arabic online commentary dataset: an annotated dataset of informal arabic with high dialectal content},
+  author={Zaidan, Omar and Callison-Burch, Chris},
+  booktitle={Proceedings of the 49th Annual Meeting of the Association for Computational Linguistics: Human Language Technologies},
+  pages={37--41},
+  year={2011}
+}
+``` 
+
+### Contributions
+
+Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.