RFD4-Proteina README

项目的 README,来自 github.com/RosettaCommons/RFD4-Proteina。合并为一个 markdown 文件:README.md。

RFD4-Proteina

A flow-matching foundation model for biomolecular design — Baker Lab × NVIDIA GenAIR

CI PyPI Python 3.12 Documentation BSD 3-Clause License

Hugging Face model Hugging Face dataset Diffusers pipeline ZeroGPU Space Dedicated GPU Space

Project page · Paper · Try it now · Requirements · Installation · Quick start · Workflows · Tutorials · Citation · Documentation

Nanobody complex, protein–DNA binder, RNA pseudoknot, ligand pocket, glycan complex, and protein assembly.

Try it now

No install needed: design in your browser with the Hugging Face Studio Spaces.

Both require a Hugging Face sign-in, and both screen designs with SecureDNA.

RFD4-Proteina designs proteins and biomolecular complexes with sequence–structure co-design, motif and binding-site conditioning, partial diffusion, and reward-guided search.

Key features:

System requirements

Install

Start with make setup. On a machine that meets the requirements above:

git clone https://github.com/RosettaCommons/RFD4-Proteina.git
cd RFD4-Proteina
make setup
source .venv/bin/activate

The repository history is large because of past notebook outputs. For a fast clone use git clone --depth 1 (no history) or git clone --filter=blob:none (full history, blobs fetched on demand). Notebooks are committed without outputs; run pre-commit install to enforce this with nbstripout.

Setup installs the environment, caches the released Hugging Face model bundle (about 1.7 GB, including its autoencoder), and configures DATA_PATH for optional data. The cache location follows HF_HOME. See the installation guide for CUDA build prerequisites, optional metrics, and cluster setup.

Setup also asks whether to add an AlphaFold 2 or AlphaFold 3 / OpenFold3 environment for reward-guided search and refolding metrics (and, if so, your CPU architecture and CUDA version). Skip that with bash setup.sh --skip-search-envs; run it later with bash scripts/setup_search_envs.sh.

Other options (CUDA 12, CPU-only, Docker, Apptainer, pip) are listed in the deployment options. For example, a container with CUDA 13 (use RFD4_ACCELERATOR=cu12 or cpu for the others):

docker build -t rfd4-proteina:cu13 .
docker run --rm --gpus all rfd4-proteina:cu13 rfd4-generate --help

If access to the Hugging Face repositories is restricted, supply HF_TOKEN or use hf auth login with an account that has access. For interactive login on a fresh checkout, run bash setup.sh --skip-weights, activate .venv, log in, then run bash setup.sh --native. Public repositories need no authentication.

Quick start with pip

On Linux x86_64 with Python 3.12, an NVIDIA GPU and a CUDA 13-compatible driver. Older pip releases still trust the compromised eMudhra/emSign CA (October 2026), so the first command installs pip 26.2.2 from a hash-pinned URL before uv is downloaded:

pip install "pip @ https://files.pythonhosted.org/packages/3f/06/3e4420302363fbb71be3c7f35ce042f54bfca330e3e66b3a2e3c4cca579f/pip-26.2.2-py3-none-any.whl#sha256=fd7f4dfa8190e014013b9f08f3e973f4e4c26ffd179a204895533a7254813a70"
pip install "uv>=0.13.4"            # or: curl -LsSf https://astral.sh/uv/install.sh | sh
uv venv --python 3.12 && source .venv/bin/activate
uv pip install "rfd4-proteina[all-cuda13]"   # CUDA 12: all-cuda12; the base package alone is "rfd4-proteina"

# a binder to PD-L1: download the target, describe the design in YAML, generate
curl -LO https://raw.githubusercontent.com/RosettaCommons/RFD4-Proteina/main/docs/examples/inputs/5o45_cropped.cif.zst
cat > binder.yaml <<'EOF'
binder:
  input: 5o45_cropped.cif.zst
  contig: "50-120, /0, A17-131"
  conditions: {C_CRDGRP: {1: [{select: "sel('A/*/*/[N,CA,C,O]')"}]},
               C_SEQ: {true: [{select: "sel('A')"}]}}
EOF
rfd4-generate inference_experiment=quickstart inputs=binder.yaml out_dir=./runs/first

The quickstart preset skips scoring and the torch.compile warm-up so a first run finishes quickly; drop it for larger runs.

The environment is about 7 GB, mostly PyTorch and the CUDA libraries. uv downloads in parallel and caches wheels, so it installs in about two minutes on a fresh cluster node where plain pip takes about ten; pip install works too, only more slowly.

The model can also be run as a Hugging Face Diffusers pipeline. The quickstart covers all three routes in order: GitHub clone, PyPI and Diffusers.

The CUDA extra also installs the fused cuEquivariance kernels the model loads, so use it even if you skip metrics. Add inference_backend=bioir to use the BioIR runtime (included in all-cuda13). all-cuda12 and the plain package use the native runtime. If pip cannot see a very recent release, retry with --no-cache-dir.

For the single-worker Docker/Kubernetes API, see the deployment guide.

Run the model

After setup, describe a design in a small YAML condition spec. This one asks for a 50-120 residue binder to PD-L1, using an input included in the repository. Save it as binder.yaml in the repository root:

binder:
  input: docs/examples/inputs/5o45_cropped.cif.zst
  contig: "50-120, /0, A17-131"
  conditions: {C_CRDGRP: {1: [{select: "sel('A/*/*/[N,CA,C,O]')"}]},
               C_SEQ: {true: [{select: "sel('A')"}]}}

and run it:

rfd4-generate inputs=binder.yaml num_replicates=2 out_dir=./runs/first '~metrics'

JSON with the same keys works too. Designs are written to runs/first/inference_samples/. '~metrics' skips scoring, so no refolding environment is needed (quote it so zsh keeps the ~). Add compile_lengths=null to a first smoke test to skip the torch.compile warm-up. Next: design a binder in 10 lines, the cookbook with a recipe per task (monomers, binders, enzymes, nanobodies, small molecules, partial diffusion), or your own annotated input.

Hugging Face and Python

To load the model from the Hugging Face Hub, with no local checkpoints and no DATA_PATH, pass hf_ckpt_path; use a different Hub repo or a local exported bundle the same way:

rfd4-generate hf_ckpt_path=nvidia/RFD4-Proteina \
    inference_experiment=quickstart inputs=design.yaml out_dir=./runs/hf

Install it with uv pip install rfd4-proteina on a supported CUDA/Python system. The same API works from an installed development checkout:

import rfd4_proteina as rfd4

model = rfd4.Proteina.from_pretrained("nvidia/RFD4-Proteina")
rfd4.generate(model, overrides=["inference_experiment=quickstart", "inputs=design.yaml", "out_dir=runs/hf"])

Use an annotated CIF or condition-spec YAML as inputs. Add revision="<commit>" to from_pretrained (or hf_ckpt_revision=<commit> to the CLI) for reproducibility. HF caches downloaded weights; rfd4.generate reuses the loaded model. For a native local checkpoint, set hf_ckpt_path=null, ckpt_path=/path/to/checkpoints, ckpt_name=model.ckpt, and autoencoder_ckpt_path=/path/to/ae.ckpt. Training datasets are separate from model downloads: see the training guide.

More workflows

Tutorials

Citation

If you use RFD4-Proteina in your research, please cite Biomolecular design through latent reasoning with RFD4-Proteina:

@article{corley2026rfd4proteina,
  title        = {Biomolecular design through latent reasoning with {RFD4-Proteina}},
  author       = {Corley, Nathaniel and Didi, Kieran and Kazman, Maxwell W. and Brent, Rafael I. and others},
  year         = {2026},
  journal      = {bioRxiv},
  doi          = {10.64898/2026.11.12.766037},
  url          = {https://www.biorxiv.org/content/10.64898/2026.11.12.766037v1}
}

See the project page for citation updates.

Documentation · Contributing · BSD 3-Clause license

Protein-binder generation conditioned on a DNA duplex.

RFD4-Proteina (RosettaCommons/RFD4-Proteina)

正在搜索数据库…

这是什么?RFD4-Proteina 是来自 Baker 实验室与 NVIDIA GenAIR 的流匹配基础模型,用于生成式蛋白质和生物分子设计。它支持序列-结构协同设计,并可结合基序、结合位点和奖励引导条件,用于设计结合蛋白、抗体、酶和小分子口袋等任务。
这是 Python 库、命令行工具,还是在线应用?三者都是——它提供 Python API、rfd4-generate/rfd4-evaluate/training 命令行工具和 Hugging Face Diffusers 管线,还提供无需安装、可在浏览器中试用的 Hugging Face Studio Space。
我该如何让它运行起来?克隆仓库并运行 `make setup`,它会搭建运行环境,并缓存已发布的 Hugging Face 模型包(约 1.7 GB)。你也可以使用 pip 快速安装方式:`uv pip install rfd4-proteina`;或拉取 CUDA 13/12 或仅 CPU 的 Docker 或 Apptainer 镜像。
我需要特定的 GPU 和 CUDA 版本吗?需要——它要求 Linux x86_64、Python 3.12,以及驱动兼容 CUDA 13 的 NVIDIA GPU(同时也提供 CUDA 12 和仅 CPU 的容器)。奖励引导搜索可选地需要 AlphaFold 2/3 或 OpenFold3 环境。
它能在 macOS 或 Windows 上运行吗?不能——仅支持搭配兼容 NVIDIA GPU 的 Linux x86_64,明确不支持 macOS 和 Windows。
它实际上支持哪些 GPU?README 指向一份受支持硬件表,其中列出了经过测试的 GPU,并提示你使用 nvidia-smi 检查兼容性;默认构建需要驱动兼容 CUDA 13,同时提供 CUDA 12 和仅 CPU 的备选方案。
开箱即用,它能处理哪些设计任务?同一个模型涵盖单体蛋白、蛋白和 DNA 结合蛋白、抗体和纳米抗体、基于基序支架的酶设计,以及小分子口袋设计。
什么是奖励引导搜索?这是一种对生成路径进行的束搜索(beam search),它利用结构预测评估器和自定义指标对候选结果打分,从而引导设计朝更优的结果发展。
我能不安装任何东西就试用吗?可以——Hugging Face Studio Spaces(ZeroGPU 或专用 GPU 池)允许你在浏览器中进行设计;两者都需要登录 Hugging Face,并会使用 SecureDNA 对设计进行筛查。
我该如何实际让它进行设计?编写一个简短的 YAML(或 JSON)条件规格文件描述任务,例如针对 PD-L1 的 50–120 个残基结合蛋白,将其保存为 binder.yaml,然后运行 rfd4-generate;输出结果会保存在 runs/first/inferencesamples/ 中。
大小
107.3 MB
星标
607
更新
提交Nov 16
时长
1个月
提交 · 90 天