This release is a pre-release and may not be stable for production use.
FennOmix-MHC
Foundation model for MHC class I peptide binding prediction built on deep contrastive learning.
See the online documentation for full API details and tutorials.
Installation
Install the latest release from PyPI:
pip install fennomix-mhc
Or install the development version directly from GitHub:
pip install git+https://github.com/FennOmix/FennOmix.MHC.git
Command line interface
After installation the fennomix-mhc command exposes several sub-commands. The examples below assume your peptide or protein sequences are stored in FASTA or tabular files.
Embed MHC proteins
fennomix-mhc embed-proteins --fasta my_hla.fasta --out-folder ./output
Embed peptides
fennomix-mhc embed-peptides --peptide-file peptides.tsv --out-folder ./output
Predict epitopes for MHC alleles
fennomix-mhc predict-epitopes-for-mhc --peptide-file peptides.tsv \
--alleles A02_01,B07_02 --out-folder ./output
Predict MHC binders for given epitopes
fennomix-mhc predict-mhc-binders-for-epitopes --peptide-file peptides.tsv \
--out-folder ./output
Additional commands deconvolute-peptides and deconvolute-and-predict-peptides are also available.
Pipeline API
All functionality of the command line interface is available through the fennomix_mhc.pipeline_api module:
from fennomix_mhc.pipeline_api import (
embed_proteins,
embed_peptides_from_file,
predict_epitopes_for_mhc,
predict_mhc_binders_for_epitopes,
)
# compute and save embeddings
embed_proteins("my_hla.fasta", "./output")
embed_peptides_from_file("peptides.tsv", "./output")
# run predictions using the saved files
predict_epitopes_for_mhc(
"peptides.tsv",
["A02_01"],
"./output",
)
Metadata
Release files for fennomix-mhc 0.0.1.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fennomix-mhc-0.0.1.dev0.tar.gz | 108.7 kB | Without provenance | Details for fennomix-mhc-0.0.1.dev0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fennomix_mhc-0.0.1.dev0-py3-none-any.whl | Python 3 | none | any | Details for fennomix_mhc-0.0.1.dev0-py3-none-any.whl |
Total release size: 225.5 kB
Release files / fennomix-mhc-0.0.1.dev0.tar.gz
| Download URL | fennomix-mhc-0.0.1.dev0.tar.gz |
|---|---|
| Size | 108.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f60f6c634d86093ecabbae1397a15ba6ddb3246c2d30b85dd219dd443b48003
|
|
BLAKE2b-256 checksum How to use checksums |
3fff1b1bee3a110094334991a95b4033ed182bedfb4f21d6d09e83cf9ed992e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.11
|
Release files / fennomix_mhc-0.0.1.dev0-py3-none-any.whl
| Download URL | fennomix_mhc-0.0.1.dev0-py3-none-any.whl |
|---|---|
| Size | 116.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a5ff82106bfc4f62e54db8810bd3e57c697a1befe5cb44579084d0ebfa245bb
|
|
BLAKE2b-256 checksum How to use checksums |
78847027a2611c6303f4858148dcf4245e91045d59402f736e6a7b738a4229f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.11
|
Security for fennomix-mhc 0.0.1.dev0
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.