Skip to main content

MHC ligand prediction tool

Project description

MHCSeqNet

PyPI version Please Cite Source code

What is MHCSeqNet?

MHCSeqNet is a MHC ligand prediction python package developed by the Computational Molecular Biology Group and S3Bio Lab at Chulalongkorn University, Bangkok, Thailand. MHCSeqNet utilizes recurrent neural networks to process input ligand's and MHC allele's amino acid sequences and therefore can be to extended to handle peptide of any length and any MHC allele with known amino acid sequence.

version history

1.0: The model was trained using only data from MHC class I and supports peptides ranging from 8 to 15 amino acids in length, but the model can be re-trained to support more alleles and wider ranges of peptide length.

1.1.0: The package was update to the latest version of Tensorflow and only support for onehot model prediction

Please see our Publication for more information.

Models

MHCSeqNet offers two versions of prediction models

  1. One-hot model: This model uses data from each MHC allele to train a separate predictor for that allele. The list of supported MHC alleles for the current release can be found here

  2. Sequence-based model: This model use data from all MHC alleles to train a single predictor that can handle any MHC allele whose amino acid sequence is known. For more information on how our model learns MHC allele information in the form of amino acid sequence, please see our Publication. The list of MHC alleles used to train this model can be found here

How to install?

MHCSeqNet requires Python 3 (>= 3.8) and the following Python packages:

numpy
tensorflow (>= 2.10.0)

If your system has both Python 2 and Python 3, please ensure that Python 3 is used when following these instructions. So that you know, we cannot promise whether MHCSeqNet will work with older versions of these packages.

install packages

python -m pip install MHCSeqNet

Install MHCSeqNet from the source

  1. Clone this repository
git clone https://github.com/s3bio/MHCSeqNet

Or you may find other methods for cloning a GitHub repository here

  1. Install the latest version of 'pip' and 'setuptools' packages for Python 3 if your system does not already have them
python -m ensurepip --default-pip
pip install setuptools

If you have trouble with this step, more information can be found here

  1. Run Setup.py inside the MHCSeqNet directory to install MHCSeqNet.
cd MHCSeqNet
python Setup.py install

How to use MHCSeqNet?

MHCSeqNet can be launched through the MHCSeqNet script or by editing sample scripts explained below

$ MHCSeqNet -h

usage: MHCSeqNet [-h] [-p PATH] [-m {onehot,sequence}] [-i {paired,complete}] peptide_file allele_file output_file

positional arguments:
  peptide_file          should each contains only one column, without header row
  allele_file           should each contains only one column, without header row
  output_file

optional arguments:
  -h, --help            show this help message and exit
  -p PATH, --path PATH  Specify the path to pre-trained model directory. This should be either the 'one_hot_model' or the 'sequence_model' directory located in 'PATH/PretrainedModels/' where PATH is where
                        MHCSeqNet was downloaded to
  -m {onehot,sequence}, --model {onehot,sequence}
                        Specify whether the one-hot model or sequence-based model will be used
  -i {paired,complete}, --input-mode {paired,complete}
                        Specify whether the prediction should be made for each pair of peptide and allele on the same row of each input file [paired] or for all combinations of peptides and alleles
                        [complete] Print this message

Sample peptide and MHC allele files can be found in the 'Samples' directory

Input format

Peptide: The current release supports peptides of length 8 - 15 and does not accept ambiguous amino acids.

MHC allele: For alleles included in the training set (i.e. supported alleles listed in the models section), the model requires the 'HLA-A*XX:YY' format.

To add new MHC alleles to the sequence-based model, the names and amino acid sequences of the new alleles must first be added to the AlleleInformation.txt and supported_alleles.txt in the sequence-based model's directory.

Output

MHCSeqNet output binding probability ranging from 0.0 to 1.0 where 0.0 indicates an unlikely ligand and 1.0 indicates a likely ligand.

How to re-train MHCSeqNet?

This feature and instruction will be added in the future

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

mhcseqnet-1.1.0.tar.gz (16.3 MB view details)

Uploaded Source

Built Distribution

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

mhcseqnet-1.1.0-py3-none-any.whl (83.2 MB view details)

Uploaded Python 3

File details

Details for the file mhcseqnet-1.1.0.tar.gz.

File metadata

  • Download URL: mhcseqnet-1.1.0.tar.gz
  • Upload date:
  • Size: 16.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.20

File hashes

Hashes for mhcseqnet-1.1.0.tar.gz
Algorithm Hash digest
SHA256 2e35a8759c3c5d97de9abdb38566c7538bf68313752e3ac30964a893c763d2b9
MD5 2b8ed9c61181ebde2ce66c0ebf540edd
BLAKE2b-256 099711f40fa4721ad77712c387192326f13fa5b281dcbec057d28dc585bbf000

See more details on using hashes here.

File details

Details for the file mhcseqnet-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: mhcseqnet-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 83.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.20

File hashes

Hashes for mhcseqnet-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16cd011612b89c6d98dfa6caa01cd7a5e000be6a6684166ae21a372884360fa4
MD5 80888f7a8c0919256fd74c4f2bdb63af
BLAKE2b-256 d0ef8ed12b21828e3f4b3dd2dc5bba4b6047502852a7422fe0452cf8a77d87d4

See more details on using hashes here.

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