sadrasabouri commited on
Commit
c09042e
1 Parent(s): 5703713

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +126 -2
README.md CHANGED
@@ -1,5 +1,129 @@
1
  ---
2
- license: mit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
4
 
5
- Comming soon!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ language:
3
+ - fa
4
+ license:
5
+ - mit
6
+ multilinguality:
7
+ - monolingual
8
+ size_categories:
9
+ - 200M<n<300M
10
+ task_categories:
11
+ - language-modeling
12
+ - masked-language-modeling
13
+ task_ids:
14
+ - language-modeling
15
+ - masked-language-modeling
16
+ pretty_name: naab-raw (raw version of the naab corpus)
17
  ---
18
 
19
+ # naab-raw (raw version of the naab corpus)
20
+ _[If you want to join our community to keep up with news, models and datasets from naab, click on [this](https://docs.google.com/forms/d/e/1FAIpQLSe8kevFl_ODCx-zapAuOIAQYr8IvkVVaVHOuhRL9Ha0RVJ6kg/viewform) link.]_
21
+
22
+ ## Table of Contents
23
+ - [Dataset Card Creation Guide](#dataset-card-creation-guide)
24
+ - [Table of Contents](#table-of-contents)
25
+ - [Dataset Description](#dataset-description)
26
+ - [Dataset Summary](#dataset-summary)
27
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
28
+ - [Languages](#languages)
29
+ - [Dataset Structure](#dataset-structure)
30
+ - [Data Instances](#data-instances)
31
+ - [Data Fields](#data-fields)
32
+ - [Data Splits](#data-splits)
33
+ - [Dataset Creation](#dataset-creation)
34
+ - [Curation Rationale](#curation-rationale)
35
+ - [Contribution Guideline](#contribution-guideline)
36
+ - [Source Data](#source-data)
37
+ - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
38
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
39
+ - [Additional Information](#additional-information)
40
+ - [Dataset Curators](#dataset-curators)
41
+ - [Licensing Information](#licensing-information)
42
+ - [Citation Information](#citation-information)
43
+ - [Contributions](#contributions)
44
+
45
+ ## Dataset Description
46
+
47
+ - **Homepage:** [Sharif Speech and Language Processing Lab](https://huggingface.co/SLPL)
48
+ - **Paper:** [If the dataset was introduced by a paper or there was a paper written describing the dataset, add URL here (landing page for Arxiv paper preferred)]()
49
+ - **Point of Contact:** [Sadra Sabouri](mailto:sabouri.sadra@gmail.com)
50
+
51
+ ### Dataset Summary
52
+ SOON
53
+
54
+ ### Supported Tasks and Leaderboards
55
+
56
+ This corpus can be used for training all language models which can be trained by Masked Language Modeling (MLM) or any other self-supervised objective.
57
+
58
+ - `language-modeling`
59
+ - `masked-language-modeling`
60
+
61
+ ## Dataset Structure
62
+
63
+ Each row of the dataset will look like something like the below:
64
+ ```json
65
+ {
66
+ 'text': "این یک تست برای نمایش یک پاراگراف در پیکره متنی ناب است.",
67
+ }
68
+ ```
69
+ + `text` : the textual paragraph.
70
+
71
+
72
+ ### Data Splits
73
+
74
+ SOON
75
+
76
+ ## Dataset Creation
77
+
78
+ ### Curation Rationale
79
+
80
+ SOON
81
+
82
+ ### Contribution Guideline
83
+
84
+ ### Source Data
85
+
86
+ SOON
87
+
88
+ ### Personal and Sensitive Information
89
+
90
+ Since this corpus is briefly a compilation of some former corpora we take no responsibility for personal information included in this corpus. If you detect any of these violations please let us know, we try our best to remove them from the corpus ASAP.
91
+
92
+ We tried our best to provide anonymity while keeping the crucial information. We shuffled some parts of the corpus so the information passing through possible conversations wouldn't be harmful.
93
+
94
+ ## Additional Information
95
+
96
+ ### Dataset Curators
97
+
98
+ + Sadra Sabouri (Sharif University of Technology)
99
+ + Elnaz Rahmati (Sharif University of Technology)
100
+
101
+ ### Licensing Information
102
+
103
+ mit?
104
+
105
+ ### Citation Information
106
+
107
+ Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:
108
+ ```
109
+ @article{article_id,
110
+ author = {Author List},
111
+ title = {Dataset Paper Title},
112
+ journal = {Publication Venue},
113
+ year = {2525}
114
+ }
115
+ ```
116
+
117
+ If the dataset has a [DOI](https://www.doi.org/), please provide it here.
118
+
119
+ ### Contributions
120
+
121
+ Thanks to [@sadrasabouri](https://github.com/sadrasabouri) and [@elnazrahmati](https://github.com/elnazrahmati) for adding this dataset.
122
+
123
+ ### Keywords
124
+ + Farsi
125
+ + Persian
126
+ + raw text
127
+ + پیکره فارسی
128
+ + پیکره متنی
129
+ + آموزش مدل زبانی