Update README.md

README.md

@@ -1,3 +1,101 @@
----
-license: odc-by
----
+---
+license: odc-by
+---
+
+# Zyda2-5T
+
+<!-- Provide a quick summary of the dataset. -->
+
+Zyda2 is a 5 trillion token language modeling dataset created by collecting open and high quality datasets and combining them and performing a uniform filtering and deduplication step. We find that Zyda performs extremely well in ablations and is at least comparable and potentially better to the best openly available datasets available, due to our meticulous post-processing pipeline. We think the best use of Zyda is either as a standalone dataset for language model training up to the 1T scale, or in combination with Fineweb or Dolma for multi-trillion token training.
+
+An early version of Zyda2 was used as the primary dataset for phase 1 pretraining of our Zamba2 series [of](Zyphra/Zamba2-2.7B) [models](Zyphra/Zamba2-1.2B) which perform extremely strongly on a per-token basis and are often state-of-the-art for their size, testifying to the strength of Zyda2 as a pretraining dataset.
+
+Models trained on Zyda2 significantly outperform identical models trained on the Pile, RefinedWeb, FineWeb, FineWeb-Edu, and DCLM.
+
+According to our evaluations, Zyda2 is the most performant per-token open dataset available. Zyda2 excels at educational and natural language reasoning content. For code performance, we reccomend mixing it with a pure code dataset such as [Starcoder](https://huggingface.co/bigcode/starcoder).
+
+
+## How to download
+
+// TODO
+
+## Breakdown by component
+
+// TODO
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Curated by:** Zyphra
+- **Language(s) (NLP):** Primarily English
+- **License:** Open Data Commons License
+
+
+## Dataset Structure
+
+<!-- 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. -->
+
+// TODO IS THIS CORRECT YURY?
+
+
+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)
+
+### Source Data
+
+Zyda2 is comprised of four high quality open-source datasets.
+
+Zyda1: https://huggingface.co/datasets/Zyphra/Zyda
+
+Dolma-1.7-cc https://huggingface.co/datasets/allenai/dolma
+
+DCLM-baseline: https://huggingface.co/datasets/mlfoundations/dclm-baseline-1.0
+
+FineWeb-Edu-2 https://huggingface.co/datasets/HuggingFaceFW/fineweb-edu
+
+
+// Pie chart of composition -- YURY!
+
+#### 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. -->
+
+Zyda was created using a two stage post-processing pipeline consisting of *filtering* and *deduplication*.
+
+For the filtering stage, we utilized a set of hand-crafted and tuned filters derived from a number of sources such as C4, RedPajama, and Gopher, in addition to our own filters.
+
+For the deduplication stage, we used minhash approximate deduplication. We deduplicated on 13-grams and used a minhash signature size of 128 and filtered out documents above a Jaccard similarity of 0.4.
+
+For full details on our data processing, see the [Zyda technical report](https://arxiv.org/abs/2406.01981) and our [dataset processing code](https://github.com/Zyphra/Zyda_processing).
+
+
+#### Personal and Sensitive Information
+
+As a language modelling dataset, it likely contains PII which has not been filtered out of the component datasets and which may have been missed by our own filters.
+
+## Bias, Risks, and Limitations
+
+As a dataset comprised of open web scrapes, it is likely that it contains biased and toxic content. 
+
+## Licensing Information
+
+We are releasing this dataset under the terms of [ODC-BY](https://opendatacommons.org/licenses/by/1-0/). By using this dataset, you are also bound by any license agreements and terms of use of the original data sources.
+
+## Citation
+
+If you use our dataset to train a model, please cite us at:
+
+```
+@misc{tokpanov2024zyda,
+      title={Zyda: A 1.3T Dataset for Open Language Modeling}, 
+      author={Yury Tokpanov and Beren Millidge and Paolo Glorioso and Jonathan Pilault and Adam Ibrahim and James Whittington and Quentin Anthony},
+      year={2024},
+      eprint={2406.01981},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```