Update README.md

README.md

@@ -12,6 +12,18 @@ configs:
     data_files:
       - split: train
         path: data/*/*
+  - config_name: sample-10BT
+    data_files:
+      - split: train
+        path: sample/10BT/*
+  - config_name: sample-100BT
+    data_files:
+      - split: train
+        path: sample/100BT/*
+  - config_name: sample-350BT
+    data_files:
+      - split: train
+        path: sample/350BT/*
   - config_name: CC-MAIN-2024-10
     data_files:
       - split: train
@@ -392,18 +404,6 @@ configs:
     data_files:
       - split: train
         path: data/CC-MAIN-2013-20/*
-  - config_name: sample-10BT
-    data_files:
-      - split: train
-        path: sample/10BT/*
-  - config_name: sample-100BT
-    data_files:
-      - split: train
-        path: sample/100BT/*
-  - config_name: sample-350BT
-    data_files:
-      - split: train
-        path: sample/350BT/*
 ---
 # 🍷 FineWeb
 <center>
@@ -464,6 +464,14 @@ You will find details on the different processing decisions we took and some int
 
 You can load the full dataset or a specific crawl/dump (see table below). Dumps have the format `CC-MAIN-(year)-(week number)`.
 
+### (Smaller) sample versions
+Along with config `default` (all the data), and the configs for each individual dump, you can also download the following configs:
+- `sample-350BT`: a subset randomly sampled from the whole dataset of around 350B gpt2 tokens (388GB)
+- `sample-100BT`: a subset randomly sampled from the whole dataset of around 100B gpt2 tokens (277.4GB)
+- `sample-10BT`: a subset randomly sampled from the whole dataset of around 10B gpt2 tokens (27.6GB)
+
+`sample-10B` was sampled from `sample-100B` which in turn was sampled from `sample-350BT`.
+
 ### Using 🏭 [`datatrove`](https://github.com/huggingface/datatrove/)
 
 ```python
@@ -471,6 +479,7 @@ from datatrove.pipeline.readers import ParquetReader
 
 # limit determines how many documents will be streamed (remove for all)
 # to fetch a specific dump: hf://datasets/HuggingFaceFW/fineweb/data/CC-MAIN-2024-10
+# replace "data" with "sample/100BT" to use the 100BT sample
 data_reader = ParquetReader("hf://datasets/HuggingFaceFW/fineweb/data", limit=1000) 
 for document in data_reader():
     # do something with document
@@ -487,6 +496,7 @@ from datatrove.pipeline.writers import JsonlWriter
 
 pipeline_exec = LocalPipelineExecutor(
     pipeline=[
+        # replace "data/CC-MAIN-2024-10" with "sample/100BT" to use the 100BT sample
         ParquetReader("hf://datasets/HuggingFaceFW/fineweb/data/CC-MAIN-2024-10", limit=1000),
         LambdaFilter(lambda doc: "hugging" in doc.text),
         JsonlWriter("some-output-path")
@@ -504,6 +514,7 @@ folder = snapshot_download(
                 "HuggingFaceFW/fineweb", 
                 repo_type="dataset",
                 local_dir="./fineweb/",
+                # replace "data/CC-MAIN-2023-50/*" with "sample/100BT/*" to use the 100BT sample
                 allow_patterns="data/CC-MAIN-2023-50/*")
 ```
 
@@ -513,6 +524,7 @@ For faster downloads, make sure to install `pip install huggingface_hub[hf_trans
 
 ```python
 from datasets import load_dataset
+# use name="sample-10BT" to use the 10BT sample
 fw = load_dataset("HuggingFaceFW/fineweb", name="CC-MAIN-2024-10", split="train", streaming=True)
 ```