Create README.md

README.md

@@ -0,0 +1,51 @@
+---
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path:
+    - gharchive/v0/documents/*.jsonl.gz
+task_categories:
+- text-generation
+language:
+- en
+pretty_name: GitHub Archive
+---
+# GitHub Archive
+
+## Description
+According to [GitHub’s terms of service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service), issues and pull request descriptions—along with the their comments—inherit the license of their associated repository. 
+To collect this data, we used the [GitHub Archive’s](https://www.gharchive.org/) public BigQuery table of events to extracted all issue, pull request, and comment events since 2011 and aggregated them into threads. 
+The table appeared to be missing “edit” events so the text from each comment is the original from when it was first posted. 
+We filtered out comments from bots. 
+This resulted in approximately 177 million threads across 19 million repositories. 
+We then removed threads whose repositories did not have a Blue Oak Council-approved license. 
+License information for each repository comes from either 1) the “public-data:github_repos” BigQuery Table, 2) metadata from the StackV2, or 3) the GitHub API. 
+License filtering left 10 million repositories. 
+PyMarkdown was used to convert from GitHub-flavored markdown to plain text. 
+When parsing failed, the raw markdown was kept.
+Per-document license information is available in the `license` entry of the `metadata` field of each example.
+Code for collecting, processing, and preparing this dataset is available in the [common-pile GitHub repo](https://github.com/r-three/common-pile).
+
+## Dataset Statistics
+| Documents | UTF-8 GB | Times seen during training| Tokens |
+------------|----------|---------------------------|--------|
+|23,358,580 |     40.4 |                        6x |  60.6B |
+
+## License Issues
+While we aim to produce datasets with completely accurate licensing information, license laundering and inaccurate metadata can cause us to erroneously assign the incorrect license to some documents (for further discussion of this limitation, please see [our paper](TODO link)). If you believe you have found an instance of incorrect licensing in this dataset, please [start a discussion](https://github.com/r-three/common-pile/discussions/new) on this repository. 
+
+## Other Versions
+This is the "filtered" version of the GitHub Archive dataset. 
+If you are looking for the raw version, you can find it [here](https://huggingface.co/datasets/common-pile/github_archive).
+
+## Citation
+If you use this dataset, please cite:
+```bibtex
+@article{kandpal2025common,
+  title={{The Common Pile v0.1: An 8TB Dataset of Public Domain and Openly Licensed Text}},
+  author={Nikhil Kandpal and Brian Lester and Colin Raffel and Sebastian Majstorovic and Stella Biderman and Baber Abbasi and Luca Soldaini and Enrico Shippole and A. Feder Cooper and Aviya Skowron and Shayne Longpre and Lintang Sutawika and Alon Albalak and Zhenlin Xu and Guilherme Penedo and Loubna Ben  and Elie Bakouch and John David  and Honglu Fan and Dashiell Stander and Guangyu Song and Aaron Gokaslan and John Kirchenbauer and Tom Goldstein and Brian R and Bhavya Kailkhura and Tyler Murray},
+  journal={arXiv preprint},
+  year={2025}
+}
+```