https://github.com/aqlaboratory/tcrcube

https://github.com/aqlaboratory/tcrcube

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: aqlaboratory
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 95.8 MB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

TCRcube: ML model for pMHC-TCR predictions

Setup

Set up TCRcube by running bash git clone https://github.com/aqlaboratory/TCRcube.git cd TCRcube pip install -e . This would clone the repository, install dependencies and set up TCRcube as a packge.

Pre-computing ESM2 / AF2 representations

  • ESM2 representations
  • AF2 representations
    • Extracted from AF2 structure predictions using TCRdock pipeline
    • Modify TCRdock scripts to output numpy arrays with repres
    • Follow the README in TCRdock repo to do AF2 predictions (and get the evoformer and structure module repres)

Inference on test set using pre-trained models

  • Use predict.py script for inference, see python predict.py -h for options
  • You will need test set CSV files and for the respective models also pre-computed ESM2 / AF2 representations.
  • See e.g. test_panpeptide.csv for example input CSV file with the test set data
  • Outputs AUROC and AUPR and CSV file with predictions for individual data points
  • Example for amino acid identity model: bash python predict.py -g 0 -t AAidpos data/test_panpeptide.csv checkpoints/panpeptide_AAidpos.pt --outfile AAidpos_panpeptide.csv
  • Example for AF2-evo model: bash python predict.py -g 0 -t AF2evo data/test_panpeptide.csv checkpoints/panpeptide_AF2-evo.pt --pos_dir AF2repres/panpeptide_pos --neg_dir AF2repres/panpeptide_neg --outfile AF2-evo_panpeptide.csv
  • Example for ESM2-isol model: bash python predict.py -g 0 -t ESM2isol data/test_panpeptide.csv checkpoints/panpeptide_ESM2-isol.pt --cdr3a_esm2isol_dir ESM2repres/cdr3a/ --cdr3b_esm2isol_dir ESM2repres/cdr3b --pep_esm2isol_dir ESM2repres/pep --mhc_esm2isol_dir ESM2repres/mhc

Training

  • Use train.py script for inference, see python train.py -h for options
  • You will need train and test set CSV files and for the respective models also pre-computed ESM2 / AF2 representations.
  • Example for training ESM2-full version of the model: bash python -u train.py -g 0 data/train_panpeptide.csv data/test_panpeptide.csv -t ESM2full --pos_dir_train ESM2repres/full_train_pos --neg_dir_train ESM2repres/full_train_neg/ --pos_dir_test ESM2repres/full_test_pos/ --neg_dir_test ESM2repres/full_train_neg/ --out_checkpoint panpeptide_ESM2-full.pt > train_panpeptide_ESM2-full.out

Owner

  • Name: AQ Laboratory
  • Login: aqlaboratory
  • Kind: organization
  • Email: m.alquraishi@columbia.edu
  • Location: Columbia University

GitHub Events

Total
  • Watch event: 6
  • Public event: 1
Last Year
  • Watch event: 6
  • Public event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 16
  • Total Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 4
  • Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
culkam m****a@g****m 16

Issues and Pull Requests

Last synced: about 1 year ago


Dependencies

setup.py pypi
  • numpy *
  • scipy *
  • torch *