Skip to main content

pMTnet Omni: pan-MHC and cross-Species Prediction of T Cell Receptor-Antigen Binding 🔬

Logo

forthebadge forthebadge

Package Documentation Code Coverage
pMTnet Omni codecov
pMTnet Omni Document Documentation Status codecov

pMTnet Omni is a deep learning algorithm for affinity prediction based on TCR Va, Vb, CDR3a, CDR3b sequences, peptide sequence, and MHC allele types. The predictions can be made for human and mouse alleles, and for both CD8 T cells/MHC class I and CD4 T cells/MHC class II.

Please refer to our paper for more details: pMTnet Omni paper link here

We host the online tool on DBAI, where you can find all the members of the pMTnet family, including pMTnet V1.

We have also built a detailed online documentation where we guide you step-by-step on how to format your data so it can be accpted by our algorithm.

NOTE: This is the documentation for the data curation supporting tool for pMTnet Omni. Use this BEFORE you upload your dataset to DBAI.

Model Overview

Model Overview

Dependencies

  • numpy==1.22.4
  • pandas==1.5.2
  • tqdm==4.64.1
  • torch==1.13.1
  • fair-esm==2.0.0

Enviroment Setup

conda env create -f pMTnet_Omni_Document_env.yml

Installation

conda activate pMTnet_Omni_Document
pip install pMTnet_Omni_Document

Quick Start Guide

  1. Prepare your dataset so that it looks somewhat like the following: Sample df Along with the main program, we also published 5 datasets under the ./validation_data folder. Feel free to use those datasets to check if you TCR namings, Amino Acid sequences, and MHC namings conform with our standard.

NOTE: When both TCR names (resp. MHC) and the TCR sequences (resp. MHC sequences) are provided, we will disregard the sequences. If the names can NOT be found in our reference database, the record WILL be dropped.

NOTE: On the other hand, if the names are NOT provided, we will use the sequences with minimal curation.

  1. Say your dataset is under ./df.csv. In your terminal, run
conda activate pMTnet_Omni_Document

python -m pMTnet_Omni_Document --file_path ./df.csv --output_folder_path ./
  1. Go to our website and upload your data including the .json file.

  2. An example output would look like this: Sample output

For a more in-depth explanation on input format, check out our online documentation.

CITATION

We have uploaded our article to bioRxiv. To cite

@article {Han2023.12.01.569599,
	author = {Yi Han and Yuqiu Yang and Yanhua Tian and Farjana J. Fattah and Mitchell S. von Itzstein and Minying Zhang and Xiongbin Kang and Donghan M. Yang and Jialiang Liu and Yaming Xue and Chaoying Liang and Indu Raman and Chengsong Zhu and Olivia Xiao and Yifei Hu and Jonathan E. Dowell and Jade Homsi and Sawsan Rashdan and Shengjie Yang and Mary E. Gwin and David Hsiehchen and Yvonne Gloria-McCutchen and Ke Pan and Fangjiang Wu and Don Gibbons and Xinlei Wang and Cassian Yee and Junzhou Huang and Alexandre Reuben and Chao Cheng and Jianjun Zhang and David E. Gerber and Tao Wang},
	title = {pan-MHC and cross-Species Prediction of T Cell Receptor-Antigen Binding},
	elocation-id = {2023.12.01.569599},
	year = {2023},
	doi = {10.1101/2023.12.01.569599},
	publisher = {Cold Spring Harbor Laboratory},
	URL = {https://www.biorxiv.org/content/early/2023/12/12/2023.12.01.569599},
	eprint = {https://www.biorxiv.org/content/early/2023/12/12/2023.12.01.569599.full.pdf},
	journal = {bioRxiv}
}

Metadata

Release files for pMTnet-Omni-Document 0.0.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pMTnet-Omni-Document 0.0.16
File Size Uploaded Provenance
pMTnet_Omni_Document-0.0.16.tar.gz 86.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pMTnet-Omni-Document 0.0.16
File Interpreter ABI Platform
pMTnet_Omni_Document-0.0.16-py3-none-any.whl Python 3 none any Details

Total release size: 172.2 kB

Release files / pMTnet_Omni_Document-0.0.16.tar.gz

Download URL pMTnet_Omni_Document-0.0.16.tar.gz
Size 86.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e67ebdbb8e5ff32256d69423b9d181ad1172ee54157dfe5c7727a310657474f4
BLAKE2b-256 checksum
How to use checksums
6df0d1059e04129fae4da05540bf25e69f5c7f6816acc5b5cecaad72d743172a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / pMTnet_Omni_Document-0.0.16-py3-none-any.whl

Download URL pMTnet_Omni_Document-0.0.16-py3-none-any.whl
Size 85.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fbb7a932fe8f743ed866001144a4d891d721861385f9154d49b402c3cdbb47de
BLAKE2b-256 checksum
How to use checksums
de3a259c3b1d7e14fb9d2311b75c764ad3c19739d2522c85bd670198fcb34df6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Security for pMTnet-Omni-Document 0.0.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page