Update ReadMe

README.md

@@ -1,3 +1,62 @@
-# CCNET Reproduce split
+---
+license: mit
+language:
+- en
+tags:
+- ccnet
+- english
+- common crawl
+- pretraining
+- internet
+- massive
+- text corpora
+- general text
+pretty_name: CCNet split (4M)
+size_categories:
+- 1M<n<10M
+---
 
-A fraction of the CCNet data pipeline, extracted by us, so that YOU dont have to.
+# CCNet Reproduced Split (4M)
+
+## Overview
+
+This dataset is a reproduced subset of the larger CCNet dataset, tailored specifically to facilitate easier access and processing for researchers needing high-quality, web-crawled text data for natural language processing tasks. The CCNet dataset leverages data from the Common Crawl, a non-profit organization that crawls the web and freely provides its archives to the public. This subset contains 4 million datapoints that have been carefully processed and structured.
+
+The CCNet repository is archived and unmaintained, so we hope this is useful for those who require to use this dataset.
+
+Feel free to contact me if you have any questions or requests.
+
+## Dataset Description
+
+### Data Collection
+
+The data in this subset was collected as part of the Common Crawl project and has been processed to retain only high-quality text contents with valuable metadata. Each entry in the dataset is derived from web pages across a diverse set of domains, ensuring a broad representation of the internet.
+
+### Data Format
+
+Each entry in the dataset is stored as a compressed JSON object in a newline-delimited format (JSONL). This format makes it straightforward to parse the data lazily, one record at a time, which is memory efficient for large datasets.
+
+#### Fields
+
+- `url`: The webpage URL from which the content is derived (part of CC).
+- `date_download`: The date when the webpage was downloaded.
+- `digest`: SHA1 digest of the webpage's content.
+- `length`: Number of characters in the webpage content after deduplication.
+- `nlines`: Number of lines in the webpage content after deduplication.
+- `source_domain`: Web domain of the webpage.
+- `title`: Title of the webpage (part of CC).
+- `raw_content`: The text content of the webpage after deduplication.
+- `original_nlines`: Number of lines before deduplication.
+- `original_length`: Number of characters before deduplication.
+- `language`: Language of the webpage, detected using FastText Language Identification.
+- `language_score`: Confidence score of the detected language.
+- `perplexity`: Perplexity of the text based on a language model trained on Wikipedia.
+
+## Usage
+
+This dataset is suitable for use in pre-training language models, studying internet-based text, and other NLP tasks that require diverse text inputs. To use this dataset, load it via the Hugging Face Datasets library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("ccnet_split_4m")