DeepRank-Ab
DeepRank-Ab is a geometric deep learning scoring function for ranking antibody-antigen docking models and predicting DockQ scores. Given a raw PDB, it runs chain detection, feature generation (ESM-2 embeddings, CDR annotation, atom-level graphs), and EGNN inference to produce a predicted DockQ score plus structural quality flags.
Publication: https://www.nature.com/articles/s42003-026-10408-4
Installation
pip install deeprank-ab
Working on the code itself instead? See DEVELOPMENT.md.
Running with Docker
Two image variants are published to GHCR: *-cpu and *-gpu, tagged <release-tag>-cpu/
<release-tag>-gpu plus latest-cpu/latest-gpu on every release. PRs also get a
pr-<number>-cpu/pr-<number>-gpu build for reviewing that PR's changes — those are
work-in-progress images, not for general use.
Mount your data directory to /data, set it as the working directory, and pass
--user "$(id -u):$(id -g)" — without it, the container runs as root and every file it creates
(workspace, *.hdf5) ends up root-owned on your host. Also mount a named volume at /cache: the
image downloads the ~2.5GB ESM-2 weights there on first run, and reuses them on every run after —
without it, each docker run re-downloads the weights from scratch:
docker run --rm \
--user "$(id -u):$(id -g)" \
-v "$PWD":/data \
-v deeprank-ab-weights:/cache \
-w /data \
ghcr.io/haddocking/deeprank-ab:latest-cpu \
test.pdb
Chain-override flags work the same way, appended after the PDB file:
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD":/data -v deeprank-ab-weights:/cache -w /data \
ghcr.io/haddocking/deeprank-ab:latest-cpu \
test.pdb --heavy_chain_id H --light_chain_id L --antigen_chain_id A
Your results will be at <pdb_stem>-deeprank_ab_pred_<...>/.
GPU
The *-gpu image (built on nvidia/cuda) needs the
NVIDIA Container Toolkit
installed on the host, plus --gpus all:
docker run --rm --gpus all --user "$(id -u):$(id -g)" -v "$PWD":/data -v deeprank-ab-weights:/cache -w /data \
ghcr.io/haddocking/deeprank-ab:latest-gpu \
test.pdb
Build locally instead of pulling:
docker build --platform linux/amd64 -f Dockerfile.cpu -t deeprank-ab:cpu .
docker build --platform linux/amd64 -f Dockerfile.gpu -t deeprank-ab:gpu .
--platform linux/amd64 matters even on Apple Silicon: the vendored hmmscan/voronota
binaries are x86-64 Linux ELF and only run correctly (via Rosetta emulation) on that platform —
an arm64 build would hit "exec format error" on them regardless of host.
Usage
deeprank-ab-predict <pdb_file>
Example:
deeprank-ab-predict example/test.pdb
Input requirements:
- PDB file (single model or ensemble supported)
- Optional chain overrides:
--heavy_chain_id,--light_chain_id,--antigen_chain_id
If not provided, chains are auto-detected via ANARCI.
Pipeline
flowchart TD
A[Workspace creation] --> B[PDB splitting]
B --> C[Chain detection]
C --> D[Antigen merging]
D --> E[FASTA generation]
E --> F[ESM embeddings]
F --> G[CDR annotation]
G --> H[Graph construction]
H --> I[VdW clash filtering]
I --> J[Clustering]
J --> K[DockQ prediction]
K --> L[CSV output]
Outputs
*_predictions.hdf5 and a final *.csv with columns:
pdb_idpredicted_dockqHL_contact_flag:ok/low_HL_contacts/not_applicablevdw_clash_flag:ok/potential_clash
Support
Open a GitHub issue for help.
Metadata
Release files for deeprank-ab 1.0.2
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 |
|---|---|---|---|---|
| deeprank_ab-1.0.2.tar.gz | 53.5 MB | With provenance | Details for deeprank_ab-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deeprank_ab-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for deeprank_ab-1.0.2-py3-none-any.whl |
Total release size: 107.0 MB
Release files / deeprank_ab-1.0.2.tar.gz
| Download URL | deeprank_ab-1.0.2.tar.gz |
|---|---|
| Size | 53.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b23e213bf4e8b69add364abe6dac5e69ad6d0f242314b61074fd426ff3f7483
|
|
BLAKE2b-256 checksum How to use checksums |
a450f305a7edc35d09f9e45aaf209cf472a489de9edbd3e65b009c793b2a0714
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logRelease files / deeprank_ab-1.0.2-py3-none-any.whl
| Download URL | deeprank_ab-1.0.2-py3-none-any.whl |
|---|---|
| Size | 53.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a69cbafcc4f9152cd066215f1fbc041135acaeb6ba5f5296eda7f1ed0a414212
|
|
BLAKE2b-256 checksum How to use checksums |
ca162c67f15ad9cb9e3c77aace042e59837e5403a88cd47b430f1d76f60f09f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logSecurity for deeprank-ab 1.0.2
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for deeprank_ab-1.0.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logA 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.