AbFlow / README.md
wenda8759's picture
Update README.md
3546b66 verified
---
license: cc-by-4.0
pipeline_tag: graph-ml
tags:
- biology
- chemistry
---
## Data and Model Weights
All datasets and pre-trained model weights are available on Hugging Face:
πŸ€— **[https://huggingface.co/wenda8759/AbFlow](https://huggingface.co/wenda8759/AbFlow)**
### Download Options
#### Option 1: Using huggingface-cli (Recommended)
```bash
# Install huggingface_hub if not already installed
pip install huggingface_hub
# Download all files
huggingface-cli download wenda8759/AbFlow --local-dir ./
# Or download specific files
huggingface-cli download wenda8759/AbFlow checkpoints/multi_cdr_design.ckpt --local-dir ./
```
#### Option 2: Using Python
```python
from huggingface_hub import snapshot_download, hf_hub_download
# Download entire repository
snapshot_download(repo_id="wenda8759/AbFlow", local_dir="./")
# Or download specific file
hf_hub_download(
repo_id="wenda8759/AbFlow",
filename="checkpoints/multi_cdr_design.ckpt",
local_dir="./"
)
```
### Model Checkpoints
| Model | Description | File |
|-------|-------------|------|
| Paratope-Centric Design | Design based on epitope | `checkpoints/paratope_centric_design.ckpt` |
| Multi-CDR Design | Design all 6 CDR regions | `checkpoints/multi_cdr_design.ckpt` |
| Structure Prediction | Predict antibody structure | `checkpoints/structure_prediction.ckpt` |
| Affinity Optimization | Optimize binding affinity | `checkpoints/affinity_optimization.ckpt` |
| ΔΔG Predictor | Predict binding energy changes | `checkpoints/ddg_predictor.ckpt` |
### Dataset Structure
After downloading, organize your data as follows:
```
AbFlow/
β”œβ”€β”€ datasets/
β”‚ β”œβ”€β”€ RAbD/
β”‚ β”‚ β”œβ”€β”€ train.json
β”‚ β”‚ β”œβ”€β”€ valid.json
β”‚ β”‚ β”œβ”€β”€ test.json
β”‚ β”‚ β”œβ”€β”€ train.pkl
β”‚ β”‚ β”œβ”€β”€ valid.pkl
β”‚ β”‚ β”œβ”€β”€ test.pkl
β”‚ β”‚ β”œβ”€β”€ train_surf.pkl
β”‚ β”‚ β”œβ”€β”€ valid_surf.pkl
β”‚ β”‚ └── test_surf.pkl
β”‚ └── IgFold/
β”‚ β”œβ”€β”€ train.json
β”‚ β”œβ”€β”€ valid.json
β”‚ β”œβ”€β”€ test.json
β”‚ └── ...
└── checkpoints/
β”œβ”€β”€ multi_cdr_design.ckpt
β”œβ”€β”€ structure_prediction.ckpt
└── ...
```