PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.1.4

PyPI

abmap

AbMAP: Antibody Mutagenesis Augmented Processing

Published26 May 2023
Direct dependencies13
Transitive dependenciesNot calculated

README

Version 0.1.4 documentation

AbMAP: Antibody Mutagenesis-Augmented Processing

image

This repository is a work in progress.

This repository contains code and pre-trained model checkpoints for AbMAP, a Protein Language Model (PLM) customized for antibodies as featured in Learning the Language of Antibody Hypervariability (Singh, Im et al. 2023). AbMAP leverages information from foundational PLMs as well as antibody structure and function, offering a multi-functional tool useful for predicting structure, functional properties, and analyzing B-cell repertoires.

Installation

AbMAP relies on ANARCI to assign IMGT labels to antibody sequences. Please see the ANARCI repo or run the following in a new conda environment:

conda install -c biocore hmmer # Can also install using `brew/port/apt/yum install hmmer`
git clone https://github.com/oxpig/ANARCI.git
cd ANARCI
python setup.py install

Then install abmap using:

pip install abmap  # (recommended) latest release from PyPI 
pip install git+https://github.com/rs239/ablm.git  # the live main branch

Usage:

After installation, AbMAP can be easily imported into your python projects or run from the command line. Please see examples/demo.ipynb for common use cases. Instructions for running via CLI are below.

Command Line Usage

Instructions In Progress

Augment

Given a sequence, generate a foundational PLM embedding augmented with in-silico mutagenesis and CDR isolation.

Train

Given a dataset of labeled pairs of sequences and their augmented embeddings, train the AbMAP model on downstream prediction tasks.

Embed

Given fasta sequences and a pre-trained AbMAP model, generate their AbMAP embeddings (fixed or variable).

Please provide feedback on the issues page or by opening a pull request. If AbMAP is useful in your work, please consider citing our bioRxiv preprint.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 13

Native requirements
13 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
numpy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
numpyruntime
scipy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
scipyruntime
pandas
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
pandasruntime
torch
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
torch (>=1.11)runtime
biopython
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
biopythonruntime
matplotlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
matplotlibruntime
seaborn
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
seabornruntime
tqdm
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
tqdmruntime
scikit-learn
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
scikit-learnruntime
h5py
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
h5pyruntime
transformers
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
transformersruntime
positional-encodings
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
positional-encodingsruntime
dscript
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
dscriptruntime

Distribution files

2 collected
abmap-0.1.4-py3-none-any.whl

bdist_wheel · 55.99 KB · Python py3

Source file
abmap-0.1.4.tar.gz

sdist · 47.51 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:30 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:2a77ba7740e0a7bbf92afc9cf4a2d487592588e8ca6484cd60b67f292f59deca

Other collected versions

View all collected versions →