Update README.md
Browse files
README.md
CHANGED
|
@@ -32,6 +32,61 @@ You can access this notebook to run with google collab:
|
|
| 32 |
|
| 33 |
[](https://colab.research.google.com/drive/1R_9aUDhxm9YDdno_Ykg8KJECd3ygQbHl?usp=sharing)
|
| 34 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 35 |
## 1. Requirements
|
| 36 |
|
| 37 |
- Python 3.9 or newer
|
|
|
|
| 32 |
|
| 33 |
[](https://colab.research.google.com/drive/1R_9aUDhxm9YDdno_Ykg8KJECd3ygQbHl?usp=sharing)
|
| 34 |
|
| 35 |
+
---
|
| 36 |
+
|
| 37 |
+
## 🚀 Quick Start with pip
|
| 38 |
+
|
| 39 |
+
ESMCBA is now available on PyPI! Install it with a single command:
|
| 40 |
+
```bash
|
| 41 |
+
pip install esmcba
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
### Basic Usage
|
| 45 |
+
|
| 46 |
+
Once installed, you can run predictions directly from the command line:
|
| 47 |
+
```bash
|
| 48 |
+
esmcba --hla A0201 \
|
| 49 |
+
--peptides KIQEGVVDYGA VLMSNLGMPS DTLRVEAFEYY \
|
| 50 |
+
--encoding epitope \
|
| 51 |
+
--output_dir ./outputs
|
| 52 |
+
```
|
| 53 |
+
|
| 54 |
+
### Complete Example
|
| 55 |
+
|
| 56 |
+
Here's a full example with multiple peptides for HLA-A*02:01:
|
| 57 |
+
```bash
|
| 58 |
+
esmcba --hla A0201 \
|
| 59 |
+
--peptides KIQEGVVDYGA VLMSNLGMPS DTLRVEAFEYY AKKPTETI FKLNIKLLGVG \
|
| 60 |
+
ETSNSFDVLK INVIVFDGKSK VDFCGKGYHLM AYPLTKHPNQ RAMPNMLRI \
|
| 61 |
+
FIASFRLFA YIFFASFYYV SLIDFYLCFL FLTENLLLYI YMPYFFTLL \
|
| 62 |
+
FLLPSLATV FLAFLLFLV YFIASFRLFA FFFLYENAFL FLIGCNYLG \
|
| 63 |
+
YLATALLTL FLHFLPRV YLCFLAFLLF YLKLTDNVYI KLMGHFAWWT \
|
| 64 |
+
TLMNVLTLV YLTNDVSFL FLPFAMGI LLADKFPV SMWSFNPET \
|
| 65 |
+
LLMPILTLT LVAEWFLAYI FLYLYALVYF LMSFTVL MWLSYFIA \
|
| 66 |
+
FLNGSCGSV LVLSVNPYV GLCVDIPGI \
|
| 67 |
+
--encoding epitope \
|
| 68 |
+
--output_dir ./outputs
|
| 69 |
+
```
|
| 70 |
+
|
| 71 |
+
### Output Files
|
| 72 |
+
|
| 73 |
+
After running, you'll find in your output directory:
|
| 74 |
+
- `A0201-ESMCBA_embeddings.npy` - Raw ESM embeddings
|
| 75 |
+
- `A0201-ESMCBA_umap.csv` - UMAP visualization coordinates
|
| 76 |
+
|
| 77 |
+
### Available Options
|
| 78 |
+
```bash
|
| 79 |
+
esmcba --help
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
Key parameters:
|
| 83 |
+
- `--hla`: HLA allele (e.g., A0201, B1402, C0501)
|
| 84 |
+
- `--peptides`: Space-separated list of peptide sequences
|
| 85 |
+
- `--encoding`: Encoding type (`epitope` or `hla`, default: `epitope`)
|
| 86 |
+
- `--output_dir`: Directory for output files (default: `./outputs`)
|
| 87 |
+
- `--batch_size`: Batch size for inference (default: 10)
|
| 88 |
+
- `--umap_dims`: UMAP dimensions, 2 or 3 (default: 2)
|
| 89 |
+
|
| 90 |
## 1. Requirements
|
| 91 |
|
| 92 |
- Python 3.9 or newer
|