update

README.md

@@ -1,3 +1,164 @@
 ---
 license: apache-2.0
+task_categories:
+- text-generation
+language:
+- en
+pretty_name: pubtext
+size_categories:
+- 100B<n<1T
 ---
+# PubText
+
+Welcome to the Open License Corpus (OLC), a 228B token corpus for training permissively-licensed language models.
+
+
+**Disclaimer**: OLC should not be considered a universally safe-to-use dataset.  We encourage users of OLC to consult a legal professional on the suitability of each data source for their application. 
+
+
+## Dataset Description
+
+- **Repository:** [Silo LM repository](https://github.com/kernelmachine/silo-lm)
+- **Paper:** [Silo LM paper](https://github.com/kernelmachine/silo-lm)
+- **Point of Contact:** [Suchin Gururangan](mailto:sg01@cs.washington.edu)
+
+### Dataset Summary
+
+
+
+  
+    
+| Domain       | Sources                                              | Specific License | # BPE Tokens (in billions; GPT-NeoX tokenizer) |
+|--------------|------------------------------------------------------|------------------|------------------|
+| Legal        | Case Law, Pile of Law (PD subset)                | Public Domain    | 27.1             |
+| Legal         | Pile of Law (CC BY-SA subset)                   | CC BY-SA         | 0.07             |
+| Code         | Github (permissive)                             | MIT/BSD/Apache   | 58.9             |
+| Conversational| HackerNews, Ubuntu IRC                         | MIT/Apache       | 5.9              |
+| Conversational             | Stack Overflow, Stack Exchange                  | CC BY-SA         | 21.3             |
+| Math         |  Deepmind Math, AMPS                             | Apache           | 3.5              |
+| Science      | ArXiv abstracts, S2ORC (PD subset)              | Public Domain    | 1.2              |
+| Science             | S2ORC (CC BY-SA subset)                        | CC BY-SA         | 70.3             |
+| Books        | Gutenberg                                       | Public Domain    | 2.9              |
+| News         | Public domain news                              | Public Domain    | 0.2              |
+| News            | Wikinews                                        | CC BY-SA         | 0.01             |
+| Encyclopedic | Wikipedia                                       | CC BY-SA         | 37.0             |
+
+
+
+### Supported Tasks and Leaderboards
+
+- `text-generation`: The dataset can be used to train a language model for text generation. The language model performance is evaluated based on perplexity.
+  
+### Languages
+
+OLC is primarily an English-language dataset, but also contains some data in other languages (primarily in the Wikipedia subset, which draws on the [Red Pajama](https://github.com/togethercomputer/RedPajama-Data) data collection)
+
+## Dataset Structure
+
+The dataset is a standard text-only structure, separated into each subset that we include in the paper. To use a subset of sources, you should specify each individually, like so:
+
+```
+import datasets
+dataset = datasets.load_dataset('open-license-corpus', ['pd_law', 'sw_github'], streaming=True)
+```
+
+### Data Instances and Fields
+
+The dataset is standard text only structure, e.g. `{"text": "this is a document"}`. We do not add any other fields to documents.
+
+### Data Splits
+
+We only include the training data in this repository.
+
+For validation data, in the paper we use the Pile validation data, which we decontaminate OLC against using a deduplication script (see more below).
+
+The Pile validation data that we use in the paper can be found [here]().
+
+## Dataset Creation
+
+
+
+
+### License Taxonomy
+
+
+* **Public Domain (PD):** Public domain text has no restrictions.
+* **Permissively licensed software (SW):** including MIT, Apache, and BSD software.
+* **Attribution licenses (BY):** such as Creative Commons Attribution (CC-BY) are free to use as long as "credit is given to the creator."
+* **All other data:** that is not in one of the above three categories is assumed to be non-permissive. This includes: any text that is explicitly protected by copyright or licenses that are non-commercial (e.g., CC-NC), any software without clear MIT, BSD, or Apache licenses, and any generic web-crawled data where the license or copyright information may be unclear.
+
+
+### Building OLC
+
+Based on this taxonomy of licenses OLC, a 228B token corpus of PD, SW, and BY data. OLC consists of 17 manually-selected sources of 
+primarily English text that are under permissive licenses.
+
+The text generally falls into eight different domains:
+
+* **Legal:** We curate legal text from the Pile of Law, an amalgation of 31 different sources of text related to civil court cases, patents, and other legal and governmental works, either licensed as public domain or CC-BY. We also gather public domain text from the Case Law Access Project, which covers over 6.5 million decisions published by state and federal courts throughout U.S. history.
+
+* **Code:**  We use the Github subset of the RedPajama dataset, which contains code from Github repositories with three permissive software licenses: MIT, Apache, and BSD.
+
+* **Conversation:** We source conversational text under permissive software licenses from the HackerNews (MIT license) and the Ubuntu IRC (Apache license) subsets of the Pile. We also use the Stackexchange subset of the RedPajama dataset and a Stackoverflow corpus from Kaggle, both under the CC-BY-SA license.
+
+* **Math:** We source mathematical text from the Deepmind Mathematics and the AMPS datasets, both of which are under the Apache license.
+
+* **Science:**  We source scientific text from ArXiv abstracts that are in the public domain. We also collect full-text articles from the Semantic Scholar Research Corpus (S2ORC), either licensed as public domain or CC-BY.
+
+* **Books:**  We source books from the Gutenberg corpus, which are copyright-expired books that are in the public domain.
+
+* **News:**  We collect public domain news text from the English subset of the MOT corpus. We also collect text from Wikinews, which is under CC BY-SA.
+
+* **Encyclopedic:**  Finally, we include a large set of Wikipedia from the subset included in RedPajama.We follow RedPajama in using Wikipedia snapshots from 20 languages even though the model primarily focuses on English.
+
+
+#### Initial Data Collection and Normalization
+
+We deduplicate text using a document-level filter that considers $n$-gram overlap. We first deduplicate within each domain to remove redundant documents from similar sources (e.g. Case Law and the Pile of Law), and then then perform deduplication against the validation and test datasets of the Pile to avoid test leakage.
+
+We do not perform any additional quality filtering, though some subsets (e.g. Github and Wikipedia) are already quality filtered by the original data curators of those subsets.
+
+#### Who are the source language producers?
+
+The source language producers vary by domain; the Legal subset primarily contains governmental documents, while the Github subset contains code repositories written by the public. We refer to each data source for further information.
+
+### Annotations
+
+The dataset does not contain any additional annotations. 
+
+#### Annotation process
+
+[N/A]
+
+#### Who are the annotators?
+
+[N/A]
+
+### Personal and Sensitive Information
+
+We do not perform additional filtering to remove personally identifiable information, so it is possible that certain subsets still pose privacy risks despite being permissively licensed.
+
+## Considerations for Using the Data
+
+Please see the disclaimer above. The license associated with a document may be time- and country-dependent Moreover, other legal constraints may prohibit the use of a data source despite a permissive data license.  We encourage users of PubText to consult a legal professional on the suitability of each data source for their application. 
+
+### Social Impact of Dataset
+
+OLC is the first multidomain, permissively licensed corpus, which can enable language models that align better to data-use regulations such as the fair-use doctrine in the United States and the GPDR in the European Union.
+
+### Discussion of Biases and Limitations
+
+While OLC mitigates copyright and privacy risks, it may exacerbate certain fairness issues, like toxicity towards marginalized groups and racial biases, especially due to the prevalence of older copyright-expired books in the training data.
+
+In addition, OLC relies on explicit metadata to identify licenses, which may lead to underestimates of the amount and diversity of permissively licensed text actually available on the web. 
+
+
+### Dataset Curators
+
+OLC was curated by the authors of SILO language models.
+
+### Licensing Information
+
+We release this corpus under the Apache 2.0 license.
+
+### Citation Information

open_license_corpus.py

@@ -0,0 +1,110 @@
+import datasets
+import os
+from datasets import load_dataset
+import gzip
+import json
+
+logger = datasets.logging.get_logger(__name__)
+
+
+CITATION = """
+"""
+
+DESCRIPTION = """
+The Open License Corpus
+"""
+
+OLC_SUBSET_NAMES = [
+    "ccby_law",
+    "ccby_s2orc",
+    "ccby_stackexchange",
+    "ccby_stackoverflow",
+    "ccby_wikinews",
+    "ccby_wikipedia",
+    "pd_arxiv_abstracts",
+    "pd_books",
+    "pd_law",
+    "pd_news",
+    "pd_s2orc",
+    "sw_amps_math",
+    "sw_dm_math",
+    "sw_github",
+    "sw_hackernews",
+    "sw_ubuntu_irc"
+] 
+
+URL = "https://huggingface.co/datasets/kernelmachine/open-license-corpus/"
+
+
+
+N_SHARDS_PER_SPLIT = {
+    "ccby_s2orc": {"train": 5000},
+    "ccby_law": {"train": 50},
+    "ccby_stackexchange": {"train": 1500},
+    "ccby_stackoverflow": {"train": 750},
+    "ccby_wikinews": {"train": 42},
+    "ccby_wikipedia": {"train": 3000},
+    "pd_arxiv_abstracts": {"train": 1},
+    "pd_books": {"train": 150},
+    "pd_law": {"train": 2000},
+    "pd_news": {"train": 10},
+    "pd_s2orc": {"train": 30},
+    "sw_amps_math": {"train": 2},
+    "sw_dm_math": {"train": 239},
+    "sw_github": {"train": 2500},
+    "sw_hackernews": {"train": 16},
+    "sw_ubuntu_irc": {"train": 27}
+}
+
+#DATA_URL = 'https://huggingface.co/datasets/kernelmachine/open-license-corpus/blob/main/data/{name}/{split}-{index:05d}-of-{n_shards:05d}.jsonl.gz'
+DATA_URL = 'https://huggingface.co/datasets/kernelmachine/open-license-corpus/resolve/main/data/{name}/{split}-{index:05d}-of-{n_shards:05d}.jsonl.gz'
+
+class OpenLicenseCorpusConfig(datasets.BuilderConfig):
+    def __init__(self, features, citation, **kwargs):
+        super().__init__(**kwargs)
+
+
+class OpenLicenseCorpus(datasets.GeneratorBasedBuilder):
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name=name)
+        for name in OLC_SUBSET_NAMES
+    ]
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "text": datasets.Value("string"),
+                }
+            ),
+            supervised_keys=None,
+            homepage=URL,
+            citation=CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        data_urls = {}
+        for split in ["train"]:
+            n_shards = N_SHARDS_PER_SPLIT[self.config.name][split] - 1
+            data_urls[split] = [
+                DATA_URL.format(name=self.config.name, split=split, index=index, n_shards=n_shards)
+                for index in range(n_shards)
+            ]
+
+        train_downloaded_files = dl_manager.download(data_urls["train"])
+        
+        return [datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepaths": train_downloaded_files})]
+
+    def _generate_examples(self, filepaths):
+        """This function returns the examples in the raw (text) form by iterating on all the files."""
+        id_ = 0
+        for filepath in filepaths:
+            logger.info("generating examples from = %s", filepath)
+            with gzip.open(open(filepath, "rb"), "rt", encoding="utf-8") as f:
+                for line in f:
+                    if line:
+                        example = json.loads(line)
+                        yield id_, example
+                        id_ += 1