sadrasabouri
commited on
Commit
•
1511ed6
1
Parent(s):
d2270c6
Update README.md
Browse files
README.md
CHANGED
@@ -33,8 +33,6 @@ _[If you want to join our community to keep up with news, models and datasets fr
|
|
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)
|
@@ -82,13 +80,25 @@ This corpus contains only a split (the `train` split).
|
|
82 |
|
83 |
### Curation Rationale
|
84 |
|
85 |
-
|
|
|
|
|
|
|
|
|
86 |
|
87 |
### Contribution Guideline
|
88 |
|
89 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
90 |
|
91 |
-
SOON
|
92 |
|
93 |
### Personal and Sensitive Information
|
94 |
|
@@ -105,7 +115,7 @@ We tried our best to provide anonymity while keeping the crucial information. We
|
|
105 |
|
106 |
### Licensing Information
|
107 |
|
108 |
-
mit
|
109 |
|
110 |
### Citation Information
|
111 |
|
|
|
33 |
- [Dataset Creation](#dataset-creation)
|
34 |
- [Curation Rationale](#curation-rationale)
|
35 |
- [Contribution Guideline](#contribution-guideline)
|
|
|
|
|
36 |
- [Personal and Sensitive Information](#personal-and-sensitive-information)
|
37 |
- [Additional Information](#additional-information)
|
38 |
- [Dataset Curators](#dataset-curators)
|
|
|
80 |
|
81 |
### Curation Rationale
|
82 |
|
83 |
+
Here are some details about each part of this corpus.
|
84 |
+
|
85 |
+
#### CC-fa
|
86 |
+
|
87 |
+
The Common Crawl corpus contains petabytes of data collected since 2008. It contains raw web page data, extracted metadata, and text extractions. We use the Farsi part of it here.
|
88 |
|
89 |
### Contribution Guideline
|
90 |
|
91 |
+
In order to add your dataset, you should follow the below steps and make a pull request in order to be merged with the _naab-raw_:
|
92 |
+
|
93 |
+
1. Add your dataset to `_CORPUS_URLS` in `naab-raw.py` like:
|
94 |
+
```python
|
95 |
+
...
|
96 |
+
"DATASET_NAME": "LINK_TO_A_PUBLIC_DOWNLOADABLE_FILE.txt"
|
97 |
+
...
|
98 |
+
```
|
99 |
+
2. Add a log of your changes to the [CHANGELOG.md](https://huggingface.co/datasets/SLPL/naab-raw/blob/main/CHANGELOG.md).
|
100 |
+
3. Add some minor descriptions to the [Curation Rationale](#curation-rationale) under a subsection with your dataset name.
|
101 |
|
|
|
102 |
|
103 |
### Personal and Sensitive Information
|
104 |
|
|
|
115 |
|
116 |
### Licensing Information
|
117 |
|
118 |
+
mit
|
119 |
|
120 |
### Citation Information
|
121 |
|