Update README.md

README.md

@@ -1,4 +1,27 @@
 ---
+language:
+- ar
+- de
+- en
+- es
+- fr
+- it
+- ja
+- ko
+- pt
+- ru
+- zh
+language_bcp47:
+- zh-Hans
+- zh-Hant
+multilinguality:
+- multilingual
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
+- masked-language-modeling
 dataset_info:
 - config_name: ar
   features:
@@ -218,3 +241,73 @@ configs:
   - split: train
     path: zh-Hant/train-*
 ---
+
+# cc100-documents
+
+This dataset is a restructured version of the [CC-100](https://data.statmt.org/cc-100/) ([statmt/cc100](https://huggingface.co/datasets/statmt/cc100)) dataset.
+
+In the original dataset, each instance corresponds to a single paragraph (or a document boundary).
+In this version, the data has been reformed so that each instance corresponds to a single, complete document.
+
+This document-level structure makes it more convenient for processing using the `map()` and `filter()` methods in the Hugging Face Datasets library.
+
+## Languages
+
+The following languages are currently available:
+
+|Language                        |Number of examples|
+|:-------------------------------|-----------------:|
+|`ar`: Arabic                    |        15,039,879|
+|`de`: German                    |        69,023,867|
+|`en`: English                   |       247,588,106|
+|`es`: Spanish                   |        60,542,096|
+|`fr`: French                    |        62,112,712|
+|`it`: Italian                   |        24,674,591|
+|`ja`: Japanese                  |        65,613,665|
+|`ko`: Korean                    |        35,678,358|
+|`pt`: Portuguese                |        38,999,388|
+|`ru`: Russian                   |       123,181,529|
+|`zh-Hans`: Chinese (Simplified) |        40,002,855|
+|`zh-Hant`: Chinese (Traditional)|        12,328,227|
+
+## Dataset Structure
+
+### Data Instances
+
+Each instance in the dataset represents one document from the original CC-100 dataset, preserving the original document order. The original paragraphs are concatenated together, preserving the newline characters between them, to form a single document text.
+
+Example from the `en` configuration:
+
+```json
+{
+  "idx": 0,
+  "start_ln": 1,
+  "text": "Belmont Estate is on the market for $63 million and boasts roughly 22,000 square feet of luxurious..."
+}
+{
+  "idx": 1,
+  "start_ln": 8,
+  "text": "Stay well hydrated—that means you should include about 48- 64 ounces of liquid (non-calorie) each day..."
+}
+```
+
+### Data Fields
+
+- **idx** (*int64*): The index of the instance, starting from `0`.
+- **start_ln** (*int64*): The 1-based line number where the document begins in the original CC-100 text file.
+- **text** (*string*): The complete text of the document.
+
+## Dataset creation process
+
+The dataset is created from the original CC-100 text files available at https://data.statmt.org/cc-100/.
+
+The code used to create this dataset is available in the [GitHub repository](https://github.com/singletongue/cc100-documents).
+
+## License
+
+No intellectual property is claimed on the preparation of this corpus.
+By using this dataset, you are also bound by the [Common Crawl terms of use](https://commoncrawl.org/terms-of-use) in respect of the content contained in the dataset.
+
+Please refer to the following pages for license information on the original dataset:
+- https://data.statmt.org/cc-100/
+- https://huggingface.co/datasets/statmt/cc100