Skip to main content

MHC Binding Predictor

Project description

Build Status Coverage Status Open In Colab

MHCflurry

MHCflurry predicts which peptides are likely to be displayed by MHC class I molecules. It provides pretrained models for three related tasks:

  • Binding affinity: how strongly a peptide binds an MHC allele.
  • Antigen processing: whether cellular processing favors the peptide.
  • Presentation: a combined score using binding and processing predictions.

You can use the released models from the command line or Python, scan proteins for candidate epitopes, or train models on your own data.

Quick start

Install MHCflurry and download the pretrained presentation models:

pip install --pre mhcflurry
mhcflurry downloads fetch models_class1_presentation

Predict a few peptides:

mhcflurry predict \
    --alleles HLA-A0201 HLA-A0301 \
    --peptides SIINFEKL SIINFEKD SIINFEKQ \
    --out predictions.csv

Or scan a protein sequence for candidate ligands:

mhcflurry predict-scan \
    --sequences MFVFLVLLPLVSSQCVNLTTRTQLPPAYTNSFTRGVYYPDKVFRSSVLHS \
    --alleles 'HLA-A*02:01' \
    --out scan.csv

To try MHCflurry without installing anything, open the Colab notebook.

Important This source tree documents 2.3.0rc15. Use pip install mhcflurry==2.3.0rc15 for that exact version. Omitting --pre installs the latest stable 2.2.x release until 2.3.0 is final.

The historical mhcflurry-* command names remain supported for existing scripts. See the 2.3.0 release notes for details.

Documentation

Please file an issue if you have questions or encounter problems.

Citing MHCflurry

If you use MHCflurry in your research, please cite:

T. O'Donnell, A. Rubinsteyn, U. Laserson. "MHCflurry 2.0: Improved pan-allele prediction of MHC I-presented peptides by incorporating antigen processing," Cell Systems, 2020. https://doi.org/10.1016/j.cels.2020.06.010

T. O'Donnell, A. Rubinsteyn, M. Bonsack, A. B. Riemer, U. Laserson, and J. Hammerbacher, "MHCflurry: Open-Source Class I MHC Binding Affinity Prediction," Cell Systems, 2018. https://doi.org/10.1016/j.cels.2018.05.014

Development

Contributions are welcome. Start with CONTRIBUTING.md; the testing guide describes the fast local checks and full suite.

Docker

Run the latest image from Docker Hub:

docker run -p 9999:9999 --rm openvax/mhcflurry:latest

Then open http://localhost:9999 to use the included Jupyter environment. To build the image from a checkout:

docker build -t mhcflurry:latest .
docker run -p 9999:9999 --rm mhcflurry:latest

More resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mhcflurry-2.3.0rc17.tar.gz (545.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mhcflurry-2.3.0rc17-py3-none-any.whl (442.0 kB view details)

Uploaded Python 3

File details

Details for the file mhcflurry-2.3.0rc17.tar.gz.

File metadata

  • Download URL: mhcflurry-2.3.0rc17.tar.gz
  • Upload date:
  • Size: 545.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for mhcflurry-2.3.0rc17.tar.gz
Algorithm Hash digest
SHA256 faa0fe5ed6d640da6b94c3f2d3221ee8eeba6fa090b5536611a1e822826b35b3
MD5 7be27fe37b055689d419fa1ef596ad2b
BLAKE2b-256 fe2810be7592ed2fb5fe764ad8c14ce86bda779ad8b6fb2b0b0d820ec7a02b09

See more details on using hashes here.

Provenance

The following attestation bundles were made for mhcflurry-2.3.0rc17.tar.gz:

Publisher: release.yml on openvax/mhcflurry

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mhcflurry-2.3.0rc17-py3-none-any.whl.

File metadata

  • Download URL: mhcflurry-2.3.0rc17-py3-none-any.whl
  • Upload date:
  • Size: 442.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for mhcflurry-2.3.0rc17-py3-none-any.whl
Algorithm Hash digest
SHA256 2ec12e607e42c5347ee738eba639b1f7569050c37b30218ce080c5e8ef976e7d
MD5 1d2e0ef5ba24b387b023fd09ec0957c9
BLAKE2b-256 11d4afc7f17e5a1779c47f545644f2184746ae7ae8af922a1dccc74a08ec4e04

See more details on using hashes here.

Provenance

The following attestation bundles were made for mhcflurry-2.3.0rc17-py3-none-any.whl:

Publisher: release.yml on openvax/mhcflurry

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page