Update README.md

README.md

@@ -1,4 +1,18 @@
 ---
+dataset_info:
+  features:
+  - name: text
+    dtype: string
+  - name: source
+    dtype: string
+  - name: filtering_features
+    dtype: string
+  - source_other: dump
+    dtype: string
+  splits:
+  - name: train
+    num_examples: 1594197267
+  download_size: 3.3TB
 license: odc-by
 pretty_name: Zyda
 task_categories:
@@ -53,13 +67,30 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 ## Dataset Details
 
+Dataset is created by filtering and deduplicating openly available datasets.
 
 
-### Dataset Description
+## How to download
 
-<!-- Provide a longer summary of what this dataset is. -->
+Full dataset:
+`datasets.load_dataset("Zyphra/Zyda", split="train")`
+
+Full dataset without StarCoder:
+`datasets.load_dataset("Zyphra/Zyda", name="zyda_no_starcoder", split="train")`
+
+For downloading individual components put their name in the name arg of `load_dataset()`:
+- zyda_arxiv_only
+- zyda_c4-en_only
+- zyda_peS2o_only
+- zyda_pile-uncopyrighted_only
+- zyda_refinedweb_only
+- zyda_slimpajama_only
+- zyda_starcoder_only
 
 
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
 
 - **Curated by:** Zyphra
 - **Funded by [optional]:** [More Information Needed]
@@ -95,6 +126,13 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
 
+Dataset fields:
+- `text`: contains actual text for training
+- `source`: component the text is coming from
+- `filtering_features`: precomputed values of different features that were used for filtering (converted to json string)
+- `source_other`: metadata from the source dataset (converted to json string)
+
+
 [More Information Needed]
 
 ## Dataset Creation
@@ -109,6 +147,20 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
 
+Pile Uncopyrighted: https://huggingface.co/datasets/monology/pile-uncopyrighted
+
+C4-en: https://huggingface.co/datasets/allenai/c4
+
+peS2o: https://huggingface.co/datasets/allenai/peS2o
+
+RefinedWeb: https://huggingface.co/datasets/tiiuae/falcon-refinedweb
+
+SlimPajama: https://huggingface.co/datasets/cerebras/SlimPajama-627B
+
+arxiv_s2orc_parsed: https://huggingface.co/datasets/ArtifactAI/arxiv_s2orc_parsed
+
+StarCoder: https://huggingface.co/datasets/bigcode/starcoderdata
+
 #### Data Collection and Processing
 
 <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->