borjansz commited on
Commit
d43bf9b
·
verified ·
1 Parent(s): 4ba036f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -11
README.md CHANGED
@@ -14,12 +14,12 @@ license: cc-by-2.5
14
  # Macedonian Corpus - Cleaned
15
  [raw version here](https://huggingface.co/datasets/LVSTCK/macedonian-corpus-raw)
16
 
17
- ## Key Highlights
18
  - **Size**: 35.5 GB, **Word Count**: 3.31 billion
19
  - Filtered for **irrelevant and low-quality content** using C4 and Gopher filtering.
20
  - Includes text from **10+ sources** such as fineweb-2, HPLT, Wikipedia, and more.
21
 
22
- ## Overview
23
  Macedonian is widely recognized as a low-resource language in the field of NLP. Publicly available resources in Macedonian are extremely limited, and as far as we know, no consolidated resource encompassing all available public data exists. Another challenge is the state of digitalized books and documents in Macedonia. The country lags behind in this regard, with many books and documents existing only as scanned images. This makes it difficult to extract textual information, which is critical for advancing linguistic research, education, and NLP applications in Macedonian language. To address these challenges, we created this **Macedonian Corpus**. This corpus consolidates multiple sources of Macedonian text data, including books, academic papers, web content, and other textual resources.
24
 
25
  This version of the corpus is **cleaned**, meaning the data has been subjected to filtering to ensure high-quality text for NLP tasks. The filtering was done using [datatrove](https://github.com/huggingface/datatrove), mainly motivated by [fineweb-2](https://github.com/huggingface/fineweb-2), but with slightly less aggressive settings to retain a broader range of text sources.
@@ -55,7 +55,7 @@ As a further cleaning step, we performed MinHash Deduplication after step 6. The
55
 
56
  The implementation with all filtering steps can be found at [GitHub](https://github.com/LVSTCK/macedonian-corpus/blob/main/filtering).
57
 
58
- ## Dataset Sources
59
  The corpus is built by collecting and processing data from the following sources:
60
 
61
  | **Source** | **Notes** | **Origin** |
@@ -91,7 +91,7 @@ The corpus is divided into the following categories based on the origin of the d
91
 
92
 
93
  ---
94
- ## Usage
95
 
96
  This corpus is intended to support a variety of use cases, including but not limited to:
97
 
@@ -113,7 +113,7 @@ The corpus is provided as a JSONL file, where each line contains two fields:
113
 
114
  ---
115
 
116
- ## Acknowledgments
117
  We acknowledge the contributions of the following organizations and projects:
118
  - **MMORE** for text extraction from PDFs.
119
  - **Hugging Face** for the Macedonian subset of the FineWeb-2 dataset.
@@ -124,10 +124,7 @@ We acknowledge the contributions of the following organizations and projects:
124
  - **MANU (Macedonian Academy of Sciences and Arts)** for their publications, digital resources, and historical archives.
125
  - All other sources listed above for their contributions to this corpus.
126
 
127
- ## Notice and Takedown Policy
128
- We adhere strictly to copyright and data ownership laws. If you identify any material within the corpus that infringes on your rights, please contact us following the detailed steps provided in this section to have it reviewed and potentially removed.
129
-
130
- ## How to Contribute?
131
  You can contribute to the Macedonian corpus by:
132
 
133
  1. **Digitalize Books and Materials**:
@@ -141,5 +138,10 @@ You can contribute to the Macedonian corpus by:
141
  - We hope this initiative inspires institutions in Macedonia, such as libraries, universities, and research centers, to take part in the digitalization of Macedonian-language materials.
142
  - The availability of such materials will enable the development of specialized software tailored to the needs of Macedonian speakers and researchers.
143
 
144
- ## License
145
- The dataset is distributed under the **Creative Commons Attribution 2.5 (CC BY 2.5)** license. This license was selected after a manual review of the collected data to ensure compliance with the terms and conditions of the various data sources included in the corpus. Given that this corpus is a union of multiple publicly available resources, some with specific restrictions, we cannot adopt a more permissive license (e.g., CC0 or public domain) until we have verified compliance with all source licenses and permissions.
 
 
 
 
 
 
14
  # Macedonian Corpus - Cleaned
15
  [raw version here](https://huggingface.co/datasets/LVSTCK/macedonian-corpus-raw)
16
 
17
+ ## 🌟 Key Highlights
18
  - **Size**: 35.5 GB, **Word Count**: 3.31 billion
19
  - Filtered for **irrelevant and low-quality content** using C4 and Gopher filtering.
20
  - Includes text from **10+ sources** such as fineweb-2, HPLT, Wikipedia, and more.
21
 
22
+ ## 📋 Overview
23
  Macedonian is widely recognized as a low-resource language in the field of NLP. Publicly available resources in Macedonian are extremely limited, and as far as we know, no consolidated resource encompassing all available public data exists. Another challenge is the state of digitalized books and documents in Macedonia. The country lags behind in this regard, with many books and documents existing only as scanned images. This makes it difficult to extract textual information, which is critical for advancing linguistic research, education, and NLP applications in Macedonian language. To address these challenges, we created this **Macedonian Corpus**. This corpus consolidates multiple sources of Macedonian text data, including books, academic papers, web content, and other textual resources.
24
 
25
  This version of the corpus is **cleaned**, meaning the data has been subjected to filtering to ensure high-quality text for NLP tasks. The filtering was done using [datatrove](https://github.com/huggingface/datatrove), mainly motivated by [fineweb-2](https://github.com/huggingface/fineweb-2), but with slightly less aggressive settings to retain a broader range of text sources.
 
55
 
56
  The implementation with all filtering steps can be found at [GitHub](https://github.com/LVSTCK/macedonian-corpus/blob/main/filtering).
57
 
58
+ ## 📚 Dataset Sources
59
  The corpus is built by collecting and processing data from the following sources:
60
 
61
  | **Source** | **Notes** | **Origin** |
 
91
 
92
 
93
  ---
94
+ ## ⚙️ Usage
95
 
96
  This corpus is intended to support a variety of use cases, including but not limited to:
97
 
 
113
 
114
  ---
115
 
116
+ ## 🙏 Acknowledgments
117
  We acknowledge the contributions of the following organizations and projects:
118
  - **MMORE** for text extraction from PDFs.
119
  - **Hugging Face** for the Macedonian subset of the FineWeb-2 dataset.
 
124
  - **MANU (Macedonian Academy of Sciences and Arts)** for their publications, digital resources, and historical archives.
125
  - All other sources listed above for their contributions to this corpus.
126
 
127
+ ## 🤝 How to Contribute?
 
 
 
128
  You can contribute to the Macedonian corpus by:
129
 
130
  1. **Digitalize Books and Materials**:
 
138
  - We hope this initiative inspires institutions in Macedonia, such as libraries, universities, and research centers, to take part in the digitalization of Macedonian-language materials.
139
  - The availability of such materials will enable the development of specialized software tailored to the needs of Macedonian speakers and researchers.
140
 
141
+ ## ⚖️ Legal
142
+
143
+ ### Notice and Takedown Policy
144
+ We adhere strictly to copyright and data ownership laws. If you identify any material within the corpus that infringes on your rights, please contact us following the detailed steps provided in this section to have it reviewed and potentially removed.
145
+
146
+ ### License
147
+ The dataset is distributed under the **Creative Commons Attribution 2.5 (CC BY 2.5)** license. This license was selected after a manual review of the collected data to ensure compliance with the terms and conditions of the various data sources included in the corpus. Given that this corpus is a union of multiple publicly available resources, some with specific restrictions, we cannot adopt a more permissive license (e.g., CC0 or public domain) until we have verified compliance with all source licenses and permissions.