update README.md

README.md

@@ -12,40 +12,62 @@ pretty_name: Red Pajama V2 Data Foundation
 
 ### Getting Started
 
+The full RedPajama-V2 dataset is a data foundation that includes a over 100B text documents coming from 84 CommonCrawl
+snapshots and processed using the [CCNet](https://github.com/facebookresearch/cc_net) pipeline. Out of these, there are
+30B documents in the corpus that additionally come with quality signals.
+
+Check out our [blog post](XXXXX) for more details on the build process, dataset structure and schema.
+
+To familiarize yourself with the dataset, you can load the sample dataset with the following command:
+
 ```python
 from datasets import load_dataset
 
-ds = load_dataset("togethercomputer/RedPajama-Data-V2", name="en-head-middle-all") 
+ds = load_dataset("togethercomputer/RedPajama-Data-V2", name="sample") 
 ```
 
-Or you can directly download the files using the following command:
+Alternatively, you can also directly download the files using the following instructions, using english data from the
+`2023-06` snapshot and the `head_middle` partition as an example. The full set of CC snapshots included in the dataset
+is given in `_CC_SNAPSHOT_IDS`, and the available partitions are `tail`, `head_middle`. The available language tags are
+`en`, `de`, `fr`, `es`, `it`.
 
 ```bash
-wget 'https://data.together.xyz/redpajama-data-v2/v1.0.0/urls.txt'
-while read line; do
-    dload_loc=${line#https://data.together.xyz/redpajama-data-v2/v1.0.0/}
-    mkdir -p $(dirname $dload_loc)
-    wget "$line" -O "$dload_loc"
-done < urls.txt
-```
-
-After downloading the files, you can load the dataset from disk by setting the `RED_PAJAMA_DATA_DIR` environment
-variable XXXX TODO XXX
+CC_SNAPSHOT="2023-06"
+LANG="en"
+PARTITION="head_middle"
+BASE_URL="https://data.together.xyz/redpajama-data-v2/v1.0.0/"
 
-A smaller sample of the dataset can be downloaded via
+listings_file="${LANG}-${CC_SNAPSHOT}-${PARTITION}.txt"
+wget "${BASE_URL}/listings/${listings_file}"
 
-```python
-from datasets import load_dataset
+# download documents
+while read line; do
+  url="${BASE_URL}/documents/${line}.json.gz"
+  dest="documents/${line}.json.gz"
+  mkdir -p $(dirname $dest)
+  wget "$line" -O "$dest"
+done <"${LANG}-${CC_SNAPSHOT}-${PARTITION}.txt"
+
+# download other components
+COMPS=("quality_signals" "minhash" "duplicates")
+for comp in "${COMPS[@]}"; do
+  while read line; do
+    url="${BASE_URL}/${comp}/${line}.${comp}.json.gz"
+    dest="${comp}/${line}.${comp}.json.gz"
+    mkdir -p $(dirname $dest)
+    wget "$line" -O "$dest"
+  done <"${LANG}-${CC_SNAPSHOT}-${PARTITION}.txt"
+done
 
-ds = load_dataset("togethercomputer/RedPajama-Data-V2", name="en-sample")
 ```
 
-A full set of scripts to recreate the dataset from can be
+A full set of scripts to recreate the dataset including the quality signals can be
 found [here](https://github.com/togethercomputer/RedPajama-Data).
 
 ### Dataset Summary
 
-TODO: Write a sentence about the dataset
+RedPajama-V2 is a data foundation for which includes over 100B text documents, out of which 30B documents come with
+quality annotations.
 
 ### Languages
 
@@ -53,25 +75,93 @@ English, German, French, Italian, Spanish
 
 ## Dataset Structure
 
-The dataset structure is as follows:
+The datset is structure into four components, each following the same key structure:
+
+```
+├── documents
+    ├── 2018-43
+        ├── 0000
+            ├── en_head.json.gz
+            ├── ...
+            ├── it_middle.json.gz
+├── quality_signals
+    ├── 2018-43
+        ├── 0000
+            ├── en_head.signals.json.gz
+            ├── ...
+            ├── it_middle.json.gz
+├── duplicates
+    ├── 2018-43
+        ├── 0000
+            ├── en_head.duplicates.parquet
+            ├── ...
+            ├── it_middle.duplicates.parquet
+├── minhash
+    ├── 2018-43
+        ├── 0000
+            ├── en_head.minhash.parquet
+            ├── ...
+            ├── it_middle.minhash.parquet
+```
+
+Documents files, which contain the text, folow the schema defined by CCNet, and the quality signals follow the schema
 
 ```json
 {
-  TODO
+  "id": "2018-43/0000/en_head.json.gz/0",
+  "id_int": 7972430436813205988,
+  "metadata": {
+    "cc_segment": "crawl-data/...",
+    "cc_net_source": "2018-43/0000/en_head.json.gz",
+    "url": "...",
+    "source_domain": "...",
+    "language": "en",
+    "snapshot_id": "2018-43"
+  },
+  "quality_signals": {
+    "ccnet_original_length": [
+      [
+        0,
+        7033,
+        8711.0
+      ]
+    ],
+    ...,
+    "rps_doc_stop_word_fraction": [
+      [
+        0,
+        7033,
+        0.45121107
+      ]
+    ],
+    "rps_lines_num_words": [
+      [
+        0,
+        25,
+        2
+      ],
+      ...,
+      [
+        6980,
+        7033,
+        10
+      ]
+    ]
+  }
 }
 ```
 
-## Dataset Creation
+where signal scores are encoded as list of tuple `(start, end, score)`, where `start` and `end` are the locations in the
+`raw_content` string where the `score` applies.
 
-XXXX
+## Dataset Creation
 
-### Commoncrawl
-TODO
+The dataset is based on 84 snapshots provided by CommonCrawl.
 
-To cite RedPajama, please use:
+To cite RedPajama-V2, please use:
 
 ```
-@software{together2023redpajama,
+@software{together2023redpajama-v2,
   author = {Together Computer},
   title = {RedPajama-Data-v2: a living data foundation for training open LLM models},
   month = October,
@@ -80,13 +170,11 @@ To cite RedPajama, please use:
 }
 ```
 
-### License
-
-TODO: double check this
+### License ---- TODO ----
 
 Please refer to the licenses of the data subsets you use.
 
-* [Common Crawl Foundation Terms of Use](https://commoncrawl.org/terms-of-use/full/)
+* [Common Crawl Foundation Terms of Use](https://commoncrawl.org/terms-of-use)
 
 <!--
 ### Annotations