- Overview
- Results
- Resources
- How to contribute?
- Usage and reproducibility
- Acknowledgements
- Releases
- License
- Reference
- Links
ProteinGym is an extensive set of Deep Mutational Scanning (DMS) assays and annotated human clinical variants curated to enable thorough comparisons of various mutation effect predictors in different regimes. Both the DMS assays and clinical variants are divided into 1) a substitution benchmark which currently consists of the experimental characterisation of ~2.7M missense variants across 217 DMS assays and 2,525 clinical proteins, and 2) an indel benchmark that includes ∼300k mutants across 74 DMS assays and 1,555 clinical proteins.
Each processed file in each benchmark corresponds to a single DMS assay or clinical protein, and contains the following variables:
- mutant (str): describes the set of substitutions to apply on the reference sequence to obtain the mutated sequence (eg., A1P:D2N implies the amino acid 'A' at position 1 should be replaced by 'P', and 'D' at position 2 should be replaced by 'N'). Present in the the ProteinGym substitution benchmark only (not indels).
- mutated_sequence (str): represents the full amino acid sequence for the mutated protein.
- DMS_score (float): corresponds to the experimental measurement in the DMS assay. Across all assays, the higher the DMS_score value, the higher the fitness of the mutated protein. This column is not present in the clinical files, since they are classified as benign/pathogenic, and do not have continuous scores
- DMS_score_bin (int): indicates whether the DMS_score is above the fitness cutoff (1 is fit (pathogenic for clinical variants), 0 is not fit (benign for clinical variants))
Additionally, we provide two reference files for each benchmark that give further details on each assay and contain in particular:
- The UniProt_ID of the corresponding protein, along with taxon and MSA depth category
- The target sequence (target_seq) used in the assay
- For the assays, details on how the DMS_score was created from the raw files and how it was binarized
To download the benchmarks, please see DMS benchmark - Substitutions and DMS benchmark - Indels in the "Resources" section below.
The benchmarks folder provides detailed performance files for all baselines on the DMS and clinical benchmarks.
We report the following metrics:
- For DMS benchmarks in the zero-shot setting: Spearman, NDCG, AUC, MCC and Top-K recall
- For DMS benchmarks in the supervised setting: Spearman and MSE
- For clinical benchmarks: AUC
Metrics are aggregated as follows:
- Aggregating by UniProt ID (to avoid biasing results towards proteins for which several DMS assays are available in ProteinGym)
- Aggregating by different functional categories, and taking the mean across those categories.
These files are named e.g. DMS_substitutions_Spearman_DMS_level.csv, DMS_substitutions_Spearman_Uniprot_level and DMS_substitutions_Spearman_Uniprot_Selection_Type_level respectively for these different steps.
For other deep dives (performance split by taxa, MSA depth, mutational depth and more), these are all contained in the benchmarks/DMS_zero_shot/substitutions/Spearman/Summary_performance_DMS_substitutions_Spearman.csv folder (resp. DMS_indels/clinical_substitutions/clinical_indels & their supervised counterparts). These files are also what are hosted on the website.
We also include, as on the website, a bootstrapped standard error of these aggregated metrics to reflect the variance in the final numbers with respect to the individual assays.
To calculate the DMS substitution benchmark metrics:
- Download the model scores from the website
- Run
./scripts/scoring_DMS_zero_shot/performance_substitutions.sh
And for indels, follow step #1 and run ./scripts/scoring_DMS_zero_shot/performance_substitutions_indels.sh.
The full ProteinGym benchmarks performance files are also accessible via our dedicated website: https://www.proteingym.org/. It includes leaderboards for the substitution and indel benchmarks, as well as detailed DMS-level performance files for all baselines. The current version of the substitution benchmark includes the following baselines:
Except for the WaveNet model (which only uses alignments to recover a set of homologous protein sequences to train on, but then trains on non-aligned sequences), all alignment-based methods are unable to score indels given the fixed coordinate system they are trained on. Similarly, the masked-marginals procedure to generate the masked-marginals for ESM-1v and MSA Transformer requires the position to exist in the wild-type sequence. All the other model architectures listed above (eg., Tranception, RITA, ProGen2) are included in the indel benchmark.
For clinical baselines, we used dbNSFP 4.4a as detailed in the manuscript appendix (and in proteingym/clinical_benchmark_notebooks/clinical_subs_processing.ipynb).
To download and unzip the data, use the following template, replacing {VERSION} with the desired version number (e.g., "v1.1") and {FILENAME} with the specific file you want to download, as listed in the table below. The latest version is v1.1. For example, you can download & unzip the zero-shot predictions for all baselines for all DMS substitution assays as follows:
VERSION="v1.1"
FILENAME="DMS_ProteinGym_substitutions.zip"
curl -o ${FILENAME} https://marks.hms.harvard.edu/proteingym/ProteinGym_${VERSION}/${FILENAME}
unzip ${FILENAME} && rm ${FILENAME}
| Data | Size (unzipped) | Filename |
|---|---|---|
| DMS benchmark - Substitutions | 1.0GB | DMS_ProteinGym_substitutions.zip |
| DMS benchmark - Indels | 200MB | DMS_ProteinGym_indels.zip |
| Zero-shot DMS Model scores - Substitutions | 31GB | zero_shot_substitutions_scores.zip |
| Zero-shot DMS Model scores - Indels | 5.2GB | zero_shot_indels_scores.zip |
| Supervised DMS Model performance - Substitutions | 2.7MB | DMS_supervised_substitutions_scores.zip |
| Supervised DMS Model performance - Indels | 0.9MB | DMS_supervised_indels_scores.zip |
| Multiple Sequence Alignments (MSAs) for DMS assays | 5.2GB | DMS_msa_files.zip |
| Redundancy-based sequence weights for DMS assays | 200MB | DMS_msa_weights.zip |
| Predicted 3D structures from inverse-folding models | 84MB | ProteinGym_AF2_structures.zip |
| Clinical benchmark - Substitutions | 123MB | clinical_ProteinGym_substitutions.zip |
| Clinical benchmark - Indels | 2.8MB | clinical_ProteinGym_indels.zip |
| Clinical MSAs | 17.8GB | clinical_msa_files.zip |
| Clinical MSA weights | 250MB | clinical_msa_weights.zip |
| Clinical Model scores - Substitutions | 0.9GB | zero_shot_clinical_substitutions_scores.zip |
| Clinical Model scores - Indels | 0.7GB | zero_shot_clinical_indels_scores.zip |
| CV folds - Substitutions - Singles | 50M | cv_folds_singles_substitutions.zip |
| CV folds - Substitutions - Multiples | 81M | cv_folds_multiples_substitutions.zip |
| CV folds - Indels | 19MB | cv_folds_indels.zip |
Then we also host the raw DMS assays (before preprocessing)
| Data | Size (unzipped) | Link |
|---|---|---|
| DMS benchmark: Substitutions (raw) | 500MB | substitutions_raw_DMS.zip |
| DMS benchmark: Indels (raw) | 450MB | indels_raw_DMS.zip |
| Clinical benchmark: Substitutions (raw) | 58MB | substitutions_raw_clinical.zip |
| Clinical benchmark: Indels (raw) | 12.4MB | indels_raw_clinical.zip |
If you would like to suggest new assays to be part of ProteinGym, please raise an issue on this repository with a `new_assay' label. The criteria we typically consider for inclusion are as follows:
- The corresponding raw dataset needs to be publicly available
- The assay needs to be protein-related (ie., exclude UTR, tRNA, promoter, etc.)
- The dataset needs to have insufficient number of measurements
- The assay needs to have a sufficiently high dynamic range
- The assay has to be relevant to fitness prediction
If you would like new baselines to be included in ProteinGym (ie., website, performance files, detailed scoring files), please follow the following steps:
- Submit a PR to our repo with two things:
- A new subfolder under proteingym/baselines named with your new model name. This subfolder should include a python scoring script similar to this script, as well as all code dependencies required for the scoring script to run properly
- An example bash script (e.g., under scripts/scoring_DMS_zero_shot) with all relevant hyperparameters for scoring, similar to this script
- Raise an issue with a 'new model' label, providing instructions on how to download relevant model checkpoints for scoring, and reporting the performance of your model on the relevant benchmark using our performance scripts (e.g., for zero-shot DMS benchmarks). Please note that our DMS performance scripts correct for various biases (e.g., number of assays per protein family and function groupings) and thus the resulting aggregated performance is not the same as the arithmetic average across assays.
At this point we are only considering new baselines satisfying the following conditions:
- The model is able to score all mutants in the relevant benchmark (to ensure all models are compared exactly on the same set of mutants everywhere);
- The corresponding model is open source (we should be able to reproduce scores if needed).
At this stage, we are only considering requests for which all model scores for all mutants in a given benchmark (substitution or indel) are provided by the requester; but we are planning on regularly scoring new baselines ourselves for methods with wide adoption by the community and/or suggestions with many upvotes.
12 December 2023: The code for training and evaluating supervised models is currently shared in https://github.com/OATML-Markslab/ProteinNPT. We are in the process of integrating the code into this repo.
If you would like to compute all performance metrics for the various benchmarks, please follow the following steps:
- Download locally all relevant files as per instructions above (see Resources)
- Update the paths for all files downloaded in the prior step in the config script
- If adding a new model, adjust the config.json file accordingly and add the model scores to the relevant path (e.g., DMS_output_score_folder_subs)
- If focusing on DMS benchmarks, run the merge script. This will create a single file for each DMS assay, with scores for all model baselines
- Run the relevant performance script (eg., scripts/scoring_DMS_zero_shot/performance_substitutions.sh)
Our codebase leveraged code from the following repositories to compute baselines:
We would like to thank the GEMME team for providing model scores on an earlier version of the benchmark (ProteinGym v0.1), and the ProtSSN, SaProt, PoET, and MULAN teams for integrating their model in the ProteinGym repo.
Special thanks the teams of experimentalists who developed and performed the assays that ProteinGym is built on. If you are using ProteinGym in your work, please consider citing the corresponding papers. To facilitate this, we have prepared a file (assays.bib) containing the bibtex entries for all these papers.
- ProteinGym_v1.0: Initial release.
- ProteinGym_v1.1: Updates to reference file, and addition of ProtSSN and SaProt baselines.
This project is available under the MIT license found in the LICENSE file in this GitHub repository.
If you use ProteinGym in your work, please cite the following paper:
@inproceedings{NEURIPS2023_cac723e5,
author = {Notin, Pascal and Kollasch, Aaron and Ritter, Daniel and van Niekerk, Lood and Paul, Steffanie and Spinner, Han and Rollins, Nathan and Shaw, Ada and Orenbuch, Rose and Weitzman, Ruben and Frazer, Jonathan and Dias, Mafalda and Franceschi, Dinko and Gal, Yarin and Marks, Debora},
booktitle = {Advances in Neural Information Processing Systems},
editor = {A. Oh and T. Neumann and A. Globerson and K. Saenko and M. Hardt and S. Levine},
pages = {64331--64379},
publisher = {Curran Associates, Inc.},
title = {ProteinGym: Large-Scale Benchmarks for Protein Fitness Prediction and Design},
url = {https://proceedings.neurips.cc/paper_files/paper/2023/file/cac723e5ff29f65e3fcbb0739ae91bee-Paper-Datasets_and_Benchmarks.pdf},
volume = {36},
year = {2023}
}- Website: https://www.proteingym.org/
- NeurIPS proceedings: link to abstract
- Preprint: link to abstract
- Zenodo: link to zenodo
- Pypi: link to pypi