Duplicate from allenai/peS2o

Co-authored-by: Luca Soldaini <soldni@users.noreply.huggingface.co>

.flake8

@@ -0,0 +1,25 @@
+[flake8]
+max-line-length = 115
+
+ignore =
+    # these rules don't play well with black
+    # whitespace before :
+    E203
+    # line break before binary operator
+    W503
+    # line too long, who cares?
+    E501
+
+exclude =
+    .venv
+    .git
+    __pycache__
+    docs/build
+    dist
+    .mypy_cache
+    pretrain_data
+
+per-file-ignores =
+    # __init__.py files are allowed to have unused imports and lines-too-long
+    */__init__.py:F401,F403
+    */**/**/__init__.py:F401,E501

.gitattributes

@@ -0,0 +1,55 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,56 @@
+# build artifacts
+
+.eggs/
+.mypy_cache
+*.egg-info/
+build/
+dist/
+pip-wheel-metadata/
+
+
+# dev tools
+
+.envrc
+.python-version
+.idea
+.venv/
+.vscode/
+/*.iml
+
+
+# jupyter notebooks
+
+.ipynb_checkpoints
+
+
+# miscellaneous
+
+.cache/
+doc/_build/
+*.swp
+.DS_Store
+
+
+# python
+
+*.pyc
+*.pyo
+__pycache__
+
+
+# testing and continuous integration
+
+.coverage
+.pytest_cache/
+.benchmarks
+
+# documentation build artifacts
+
+docs/build
+site/
+
+# runs
+/runs/
+/wandb/
+/scratch/
+core

README.md

@@ -0,0 +1,166 @@
+---
+license:
+- odc-by
+task_categories:
+- text-generation
+- fill-mask
+language:
+- en
+tags:
+- biology
+- chemistry
+- engineering
+- computer science
+- physics
+- material science
+- math
+- psychology
+- economics
+- political science
+- business
+- geology
+- sociology
+- geography
+- environmental science
+- art
+- history
+- philosophy
+pretty_name: peS2o (Pretraining Efficiently on S2ORC)
+size_categories:
+- 10B<n<100B
+source_datasets:
+- allenai/s2orc
+---
+
+<p align="center" style="margin-top: -2em">
+<img src="https://huggingface.co/datasets/allenai/pes2o/resolve/main/logo.png" alt="peS2o logo. It's a picure of a mortar and pestle with documents flying in." width=384px height=auto>  
+</p>
+<p align="center" style="font-size: 1.2em; margin-top: -1em"><i>Pretraining Effectively on <a href="https://github.com/allenai/s2orc">S2ORC</a>!</i></p>
+
+The peS2o dataset is a collection of ~40M creative open-access academic papers,
+cleaned, filtered, and formatted for pre-training of language models. It is derived from
+the [Semantic Scholar Open Research Corpus][2]([Lo et al, 2020][1]), or S2ORC.
+
+We release multiple version of peS2o, each with different processing and knowledge cutoff
+date. We recommend you to use the latest version available.
+
+If you use this dataset, please cite:
+
+```bibtex
+@techreport{peS2o,
+    author = {Luca Soldaini and Kyle Lo},
+    year = 2023,
+    title = {{peS2o (Pretraining Efficiently on S2ORC) Dataset}},
+    institution = {{Allen Institute for AI}},
+    note = {ODC-By, \url{https://github.com/allenai/pes2o}}
+}
+```
+
+## Document Format
+
+Each document in the dataset is a dictionary with the following fields:
+
+- `added`: Date the document was added to the corpus.
+- `created`: Best-guess date for when the document was first published. Some have resolution down to the day, only down to the year.
+- `id`: Semantic Scholar Corpus ID of the document; it can be used with the [Semantic Scholar API](https://api.semanticscholar.org/) to retrieve metadata about the document (e.g., fields of study, authors).
+- `source`: Collection from which the document was sourced from. At the moment, two are supported:
+  - `s2orc`: collection of full-text papers
+  - `s2ag`: collection of title and abstracts
+- `text`: Text of the document. Paragraphs are separated by two newlines (`\n\n`).
+- `version`: version of peS2o.
+
+------
+
+
+## peS2o V2 (Latest)
+
+
+### Key Facts
+
+- *Knowledge cutoff*: 2023-01-03
+- *Number of documents*: 38.97M
+- *Number of whitespace-separated tokens**: 42.01B
+
+### Processing
+
+peS2o V2 is largely the same as V1, but it includes additional heuristics s2ag aimed at filtering out OCR errors from abstract.
+
+First, we check if the abstract was obtained from Semantic Scholar sources that are likely to contain OCR'ed content. For any abstract derived from those sources, we count how often the text contains subsequences matching `\b([A-Za-z]\s)([a-z]\s)*[A-Za-z]\b`, i.e. individual alpha letters separated by a space. This heuristic matches cases such as `A b stra ct` (2 matching subsequences), where the OCR parser inserted erroneous spaces.
+Any abstract with more than 4 matching subsequences is removed.
+
+
+#### Statistics
+
+| Dataset | Split | # Documents | # Words        |
+|:-------:|:-----:|------------:|---------------:|
+| s2orc   | train |  8,242,162  | 36,088,195,908 |
+| s2orc   | valid |     51,323  |    255,139,074 |
+| s2ag    | train | 30,569,017  |  5,920,099,207 |
+| s2ag    | valid |    109,709  |     24,029,459 |
+
+
+
+-------
+
+## peS2o V1
+
+### Key Facts
+
+- *Knowledge cutoff*: 2023-01-03
+- *Number of documents*: 67.56M
+- *Number of whitespace-separated tokens*: 47.37B
+
+### Processing
+
+Processing differs slightly wether it was derived from the full-text corpus (`s2orc`) or the title and abstract corpus (`s2ag`).
+
+#### S2ORC-derived documents
+
+Unfiltered, S2ORC contains 11.3M papers and 46.9B whitespace-separated tokens as of 2023-01-03. To derive peS2o v1, we impose the following constraints:
+
+- The paper must have a title and abstract.
+- From each paper, we use [Grobid](https://github.com/kermitt2/grobid) to extract section headers and paragraphs; figures, tables, and references, and any other non-textual content is removed. Title and abstracts are also available, but they come from the Semantic Scholar metadata (obtained through the APIs), not Grobid.
+- The paper must be in English.
+  - To determine the language of each document, we use the [pycld3](https://github.com/bsolomon1124/pycld3) library
+  - We run pycld3 on the first 2000 characters of each paragraph in the paper.
+  - The language of the paper is the most common language of the paragraphs.
+- The paper must have at least 500 whitespace-separated words.
+- The paper was published after 1969; papers published before this date are often obtained through OCR and contain unrecoverable errors.
+- The paper must have at least 5 paragraphs.
+  - All sections that have a average log word probability of less than `-20` are removed.
+  - To calculate the average log word probability, we use word frequencies extracted from the [1T Web Ngram corpus](https://catalog.ldc.upenn.edu/LDC2006T13); specifically, we use the list available [created by Rachel Tatman](https://www.kaggle.com/datasets/rtatman/english-word-frequency). A copy is hosted [here](https://ai2-s2-research-public.s3-us-west-2.amazonaws.com/lucas/google-1T-unigram/unigram_freq.csv).
+- The most frequent word in the paper consists of alpha characters only, and it appears in less than 7.5% of the document.
+  - Words are obtained by splitting the text on whitespace.
+
+The train set contains papers published before 2022-12-01;
+the validation set includes documents published after 2022-12-01 and until 2023-01-03.
+
+#### S2AG-derived documents
+
+The S2AG corpus contains titles and abstracts of papers in Semantic Scholar.
+Unfiltered, the corpus contains 91.1M papers and 15.5B whitespace-separated tokens as of 2023-01-03. To derive peS2o v1, we impose the following constraints:
+
+- Abstract must be in English.
+  - To calculate the language, we once again use pycld3
+- Title must be in English, or have average unigram log probability greater than -20.
+- Abstract must be in English.
+- Abstract must have higher than -20 average unigram log probability.
+- Abstract must have at least 50 words.
+- Abstract must have no more than 1000 words.
+- The most frequent word in the union of text and abstract must be a 2+ character alpha word, or it can be `a` followed by a 2+ character alpha word.
+- Paper was published after 1969.
+
+#### Statistics
+
+| Dataset | Split   | # Documents | # Words        |
+|:-------:|:-------:|:-----------:|:--------------:|
+|s2orc    | train   | 8,242,162   | 36,088,195,908 |
+|s2orc    | valid   | 51,323      | 255,139,074    |
+|s2ag     | train   | 59,382,301  | 11,009,123,378 |
+|s2ag     | valid   | 111,228     | 24,398,512     |
+
+
+
+
+[1]: https://aclanthology.org/2020.acl-main.447/
+[2]: https://github.com/allenai/s2orc

data/v1/train-00000-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0684c7d98a39223fdcf8cd32938ef33b99b96b432f6ffcd9645f8d6f733271d1
+size 2933378369

data/v1/train-00001-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bc27e10c528d4f1ed1812fe4b5cd3b51096887bdabed1e7b9bb21444681d8755
+size 2933433725

data/v1/train-00002-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:07018961bc6b8382ce8c44fd4854d485ea2afde0d6c0d90a4704e5fdd8312294
+size 2932228655

data/v1/train-00003-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6971e68cedfdb0c74dd5038059c2d8c7052ad1c68f481092d40a40ea97313aad
+size 2929117743

data/v1/train-00004-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2bfa635e3c35150720dba20d7b1bd1796b3613efc6cc1c1037464924bf77bb5f
+size 2933883542

data/v1/train-00005-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:01a06d8754c727b768bee70418034ae0635dfee002988f0c0d69830f0cce315f
+size 2931051517

data/v1/train-00006-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7b2a5b52fe4106b8771492ba1e2c6936b7a0cddeaf55c9340b1e3ad837ee19bc
+size 2931273709

data/v1/train-00007-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6c58a4173681111550121d67e041b1f038592b3f1827d15762df05a4c1bc9d32
+size 2931366456

data/v1/train-00008-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c95028b7517bbe9482989d66101a9488e07d4ff9049961755c72cd273ce6a8ab
+size 2931202030

data/v1/train-00009-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8b0a1b26bb0fe75948d51a4b222ba4f70c933edd21748bead1b459295456bf51
+size 2930529921

data/v1/train-00010-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fbbadcbce652aaf03c6f45b6a56e431047e3a4ca8d31e0fbe8178337ac29f884
+size 7086737257

data/v1/train-00011-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7803dcb6c7c0b7b052987de8437cfe92f9ad8611e16fd4e8196e79a849ec225d
+size 7067042770

data/v1/train-00012-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:041f3de088dbeeebd6a8cf75a59e7d26b3ca6235e22841ad905b7394bed79d72
+size 7075090265

data/v1/train-00013-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a628d08b22cae710adb028f8713d9e26922c6830ddd07f593c06e82b89f37872
+size 7091546739

data/v1/train-00014-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d57a7c49bfa498196d6a9ae143488c4dfc66bf090e682615af24fbe2c5e4ed67
+size 7073428884

data/v1/train-00015-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7fffc024d24862af9c7ce693db8232cb3f2f91ecb228a8c4508fc693eca42ffe
+size 7086180561

data/v1/train-00016-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d1e26dcd65a8ac072bf25d5f8b7327f39c86aafab166167d719c4433c7ff3ec8
+size 7080222180

data/v1/train-00017-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5aeef853cdffd7c128f5dbf6c1fc0dd709c080206782e73bbd90cb2857f2a8ac
+size 7093984573

data/v1/train-00018-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:76396f644eff7566a544917f993689d43dc0275f54065c82c62bda88b901eb99
+size 7084000796

data/v1/train-00019-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c8fcb34215afae3739a2aeb5bc7087d656833c2f1d3646d4883dfac5dbebaec3
+size 7089843111

data/v1/validation-00000-of-00002.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5acaba9ebb5ef78fd1dac155f58eb6748486a081621ba2968e6e1b34e5d0b0bc
+size 63285743

data/v1/validation-00001-of-00002.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1abafe4fb60ff1f14a98149b590fc583cdf856449b9ee452eb07a29b61791529
+size 493149782

data/v2/train-00000-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3d611791c7d89d7915a4089e5f70e6dfc66b0c3e85ace1e5e624e2b96f0e2a29
+size 1575272287

data/v2/train-00001-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d0e21450d520e13375336ab2698e887d3846ea973450867627f22096bdbd74a0
+size 1574560033

data/v2/train-00002-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a5d42ab3006c5ea74198519f66be6574c0f6f4799198f5d28d0eec9c9c26905c
+size 1575994864

data/v2/train-00003-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:00d1728fdd678b5ddafabf940832f1249bac4c969202c34164d13143ea87e2c3
+size 1572347188

data/v2/train-00004-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:903f763ac424f1e9846d6fc5f1b7800b40c8ed6dc12fb658df12c17e5b89317c
+size 1576378492

data/v2/train-00005-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e7b34125faaa2a4bf67dce970d6bf5498de04e61d4ec9f579312854c6c9d5308
+size 1573107724

data/v2/train-00006-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:26d04d202017bde5c73f69e286294c7d4adad1bf2bdc58a46ac68e137791e22f
+size 1574387579

data/v2/train-00007-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ee886df1514155eb63fc7a6b26ba60c7ff9c3c3e189759371182eadac1758c45
+size 1573938451

data/v2/train-00008-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:51b6e423b5fb6bc46431141f12723ddb33b6f77fe3bed30cc787688a27ce7b26
+size 1575673927

data/v2/train-00009-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:74107fba608238311ad379b264102c5bceb54d5eaf353c7e6901b0a772a10fe8
+size 1572398251

data/v2/train-00010-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8fc46efbe19683654170d298895f5348bd02041cc9676c8cc5358bebcf53a1f6
+size 7086709998

data/v2/train-00011-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a5a26513ea7f65330bf3b89310855c1c94e3fc6b05db475bcd8a4cea05633d50
+size 7067300169

data/v2/train-00012-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9c5d4c02e5928d849c7422edbf07676964ee88a67e790956f575b50065507d6b
+size 7074816377

data/v2/train-00013-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a27fb84971d6afd627c50e0043bf8cec03243ced8d117dc4e20a4a58189f1caa
+size 7091633287

data/v2/train-00014-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e9674b27212b346e1d0295de8396f6148a7d44c972c27e6d7c515842be794b29
+size 7073407816

data/v2/train-00015-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cdaee0f6ebf05104d24272a82dce5c6f1e1abf996614f857a35c28e26af7ed72
+size 7086214722

data/v2/train-00016-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6ace7319488203d7aef0c46d28a8b9d1ecf098785b9224c90f28c44ecc2703af
+size 7080203587

data/v2/train-00017-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5d39ad6e5ec8c271d2a1ee31bb3c85eb20fa072187c1cd8b744100f6061663e9
+size 7094041709

data/v2/train-00018-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bf5f3ca10799111f9911edb848c97a6c972d8cdaf8caa32b9e4e0dba9493e3f5
+size 7084182657

data/v2/train-00019-of-00020.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bf4d20868a3b6e40d3dd7de642a993569934cd490180a96f70ff620dc13b6fc7
+size 7089800772

data/v2/validation-00000-of-00002.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:aaef92cda11feb66d64a76e0748ed8c9086bef235fdc1a62deea4ea50ec7bee7
+size 62400020

data/v2/validation-00001-of-00002.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:32d5696a1df222ca512f3705b4bb4c732ae1814d3aca66f94f538e28663ba2c7
+size 494441994

data/v3/train-0000-of-0136.zst

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:34aa7ffe8011605f6c358346903f29e6e37607493c9760b6a1716b494c79589a
+size 644752991

data/v3/train-0001-of-0136.zst

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5edb64440eba67d28257bcff45300fc458cc523058ba66e9abb03dd88e865aaa
+size 666153152