mtalrefaie commited on
Commit
3f566a5
1 Parent(s): eb90edb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -118
README.md CHANGED
@@ -35,140 +35,82 @@ configs:
35
  - split: train
36
  path: data/train-*
37
  ---
38
- # Dataset Card for Dataset Name
39
 
40
- <!-- Provide a quick summary of the dataset. -->
41
 
42
- This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
43
 
44
- ## Dataset Details
45
 
46
- ### Dataset Description
 
47
 
48
- <!-- Provide a longer summary of what this dataset is. -->
 
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
 
51
 
52
- - **Curated by:** [More Information Needed]
53
- - **Funded by [optional]:** [More Information Needed]
54
- - **Shared by [optional]:** [More Information Needed]
55
- - **Language(s) (NLP):** [More Information Needed]
56
- - **License:** [More Information Needed]
57
 
58
- ### Dataset Sources [optional]
59
 
60
- <!-- Provide the basic links for the dataset. -->
 
 
 
 
61
 
62
- - **Repository:** [More Information Needed]
63
- - **Paper [optional]:** [More Information Needed]
64
- - **Demo [optional]:** [More Information Needed]
65
 
66
- ## Uses
 
67
 
68
- <!-- Address questions around how the dataset is intended to be used. -->
69
 
70
- ### Direct Use
 
 
 
 
 
71
 
72
- <!-- This section describes suitable use cases for the dataset. -->
73
 
74
- [More Information Needed]
 
 
 
 
 
 
 
75
 
76
- ### Out-of-Scope Use
 
77
 
78
- <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
 
 
 
 
 
79
 
80
- [More Information Needed]
81
-
82
- ## Dataset Structure
83
-
84
- <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
85
-
86
- [More Information Needed]
87
-
88
- ## Dataset Creation
89
-
90
- ### Curation Rationale
91
-
92
- <!-- Motivation for the creation of this dataset. -->
93
-
94
- [More Information Needed]
95
-
96
- ### Source Data
97
-
98
- <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
99
-
100
- #### Data Collection and Processing
101
-
102
- <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- #### Who are the source data producers?
107
-
108
- <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
109
-
110
- [More Information Needed]
111
-
112
- ### Annotations [optional]
113
-
114
- <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
115
-
116
- #### Annotation process
117
-
118
- <!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Who are the annotators?
123
-
124
- <!-- This section describes the people or systems who created the annotations. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Personal and Sensitive Information
129
-
130
- <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
131
-
132
- [More Information Needed]
133
-
134
- ## Bias, Risks, and Limitations
135
-
136
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
137
-
138
- [More Information Needed]
139
-
140
- ### Recommendations
141
-
142
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
143
-
144
- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
145
-
146
- ## Citation [optional]
147
-
148
- <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
149
-
150
- **BibTeX:**
151
-
152
- [More Information Needed]
153
-
154
- **APA:**
155
-
156
- [More Information Needed]
157
-
158
- ## Glossary [optional]
159
-
160
- <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
161
-
162
- [More Information Needed]
163
-
164
- ## More Information [optional]
165
-
166
- [More Information Needed]
167
-
168
- ## Dataset Card Authors [optional]
169
-
170
- [More Information Needed]
171
-
172
- ## Dataset Card Contact
173
-
174
- [More Information Needed]
 
35
  - split: train
36
  path: data/train-*
37
  ---
 
38
 
 
39
 
40
+ # The Arabic Pile
41
 
42
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/64da0fd923557cdce3e514c3/J0oY67lVvecV75SOlWpjc.png)
43
 
44
+ ## Introduction:
45
+ The Arabic Pile is a comprehensive dataset meticulously designed to parallel the structure of The Pile and The Nordic Pile. Focused on the Arabic language, the dataset encompasses a vast array of linguistic nuances, incorporating both Modern Standard Arabic (MSA) and various Levantine, North African, and Egyptian dialects. Tailored for the training and fine-tuning of large language models, the dataset consists of 13 subsets, each uniquely crafted to cater to different linguistic domains.
46
 
47
+ ## The Articles Subset:
48
+ This dataset has a collection of Arabic articles.
49
 
50
+ ## Other Subsets:
51
+ 1. premio-ai/TheArabicPile
52
+ 2. premio-ai/TheArabicPile_Web
53
+ 3. premio-ai/TheArabicPile_Lyrics
54
+ 4. premio-ai/TheArabicPile_Reviews
55
+ 5. premio-ai/TheArabicPile_Dialects
56
+ 6. premio-ai/TheArabicPile_Mathematics
57
+ 7. premio-ai/TheArabicPile_Conversational
58
+ 8. premio-ai/TheArabicPile_Articles
59
+ 9. premio-ai/TheArabicPile_Poetry
60
+ 10. premio-ai/TheArabicPile_Medical
61
+ 11. premio-ai/TheArabicPile_Miscellaneous
62
+ 12. premio-ai/TheArabicPile_SocialMedia
63
+ 13. premio-ai/TheArabicPile_Translations
64
+ 14. premio-ai/TheArabicPile_Books
65
 
66
+ These subsets serve distinct purposes, ranging from mathematical content to conversational dialogue, medical texts, and more. Notably, there's a dedicated subset, "premio-ai/TheArabicPile_SocialMedia," emphasizing the inclusion of language commonly found in social media contexts.
67
 
68
+ ## Dataset Description
69
+ * Curated by: Premio.AI team
70
+ * Language(s) (NLP): Arabic, multiple languages on the translation dataset.
71
+ * License: CC BY-NC 4.0 Deed - Non Commercial.
72
+ * For any commercial uses or licensing, please contact mo@premio.ai.
73
 
 
74
 
75
+ ## Data Structure
76
+ The datasets are divided into two main subsets:
77
+ 1. Original Subset: The raw data as collected from sources, without modifications.
78
+ 2. Deduplication Subset: A filtered and cleaned version, enhancing usability for large language models by reducing redundancy and noise.
79
+ The Arabic Pile extends an invitation not only for training and fine-tuning large language models but also for diverse applications across linguistic domains. Whether for research, analysis, or other linguistic endeavors, The Arabic Pile stands as a rich resource for the exploration of Arabic language intricacies.
80
 
81
+ ## Data Collection
82
+ Please refer to the paper for more details on our data collection procedures.
 
83
 
84
+ ## Data Format
85
+ The dataset has one single column called text. The text should contain the required meta data and the body combined. This was done to make sure that it will be a good fit for direct training or fine-tuning of large language models.
86
 
87
+ Please note that the meta data might require to be repeated if your training context window won’t fit the entire body of text.
88
 
89
+ ## Potential Bias
90
+ As with any large-scale dataset, The Arabic Pile is not immune to potential biases that may influence the training and performance of language models. It's crucial to transparently address these biases to ensure responsible usage and interpretation of the dataset. Here are some considerations:
91
+ 1. Dialectal Imbalance: The dataset incorporates various Arabic dialects, with a focus on Levantine, North African, and Egyptian variants. However, there might be variations in the representation of these dialects, potentially leading to an imbalance in the training data.
92
+ 2. Source Influence: Bias may arise from the sources of the original data. The dataset collects information from diverse platforms and domains, and biases inherent in those sources could transfer to the dataset.
93
+ 3. Social Media Context: Some of our datasets have language from social media platforms and online platforms. This subset may introduce biases inherent in online discourse, such as informal language, colloquial expressions, and potential subjectivity in politics, religion or culture.
94
+ 4. Genre and Domain Bias: Different subsets cater to distinct linguistic domains, such as medical texts, poetry, reviews, and more. Each domain carries its own linguistic characteristics, potentially leading to biases based on the genres represented.
95
 
96
+ ## License Information for The Arabic Pile: No Commercial Use
97
 
98
+ The Arabic Pile is released under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). This license is designed to facilitate the open sharing and collaboration of the dataset while ensuring responsible and non-commercial usage.
99
+ Key Points of the License:
100
+ * Attribution (BY): Users are free to share, adapt, and build upon the dataset, even commercially, as long as they provide appropriate attribution to the dataset creators.
101
+ * Non-Commercial (NC): The dataset may not be used for commercial purposes. Any use for commercial gain requires explicit permission from the dataset creators.
102
+ * No Additional Restrictions: The license allows for maximum freedom of use, provided the terms of attribution and non-commercial use are adhered to.
103
+ How to Cite: When using The Arabic Pile in your work, please include a proper citation to acknowledge the dataset creators. A recommended citation can be found in the model card for easy reference.
104
+ License Deed: For a comprehensive understanding of the terms and conditions, please refer to the CC BY-NC 4.0 License Deed.
105
+ By adopting this license, we aim to foster a collaborative and open environment for the exploration and advancement of Arabic language understanding and natural language processing.
106
 
107
+ ## Citation
108
+ When utilizing The Arabic Pile in your research, development, or other projects, we kindly request that you cite the dataset using the following format:
109
 
110
+ @article{alrefaie2024arabicpile,
111
+ author = {Mohamed Taher Alrefaie, Mahmoud Ibrahim Barbary, Ahmed Yasser Hassanein, Shiref Khaled Elhalawany, Karim Ashraf Elsayed, Ahmed Yasser },
112
+ title = {The Arabic Pile: A Large Scale Dataset of Diverse Text for Large Language Modeling},
113
+ year = {2024},
114
+ url = {https://huggingface.co/datasets/premio-ai/TheArabicPile}
115
+ }
116