LiangYan3612 commited on
Commit
75b5f67
Β·
verified Β·
1 Parent(s): d5a9d0b

docs: redesign Hugging Face model card

Browse files
Files changed (1) hide show
  1. README.md +80 -23
README.md CHANGED
@@ -7,33 +7,81 @@ tags:
7
  - molecule-generation
8
  - chemistry
9
  ---
10
- # NucleusDiff
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
- Official model and data artifacts for **NucleusDiff: Manifold-Constrained Nucleus-Level Denoising Diffusion Model for Structure-Based Drug Design**.
 
 
 
 
 
 
13
 
14
- - [Source code](https://github.com/yanliang3612/NucleusDiff)
15
- - [Project page](https://yanliang3612.github.io/NucleusDiff/)
16
- - [PNAS paper](https://www.pnas.org/doi/10.1073/pnas.2415666122)
17
- - [arXiv](https://arxiv.org/abs/2409.10584)
18
 
19
- ## Repository structure
 
 
 
 
20
 
21
- ### `model/`
22
 
23
- - `nucleusdiff_pretrained_model.pt` β€” pretrained NucleusDiff checkpoint.
24
 
25
- ### `data/`
26
 
27
- - `crossdocked_v1.1_rmsd1.0_pocket10_processed_w_manifold_data_version.lmdb` β€” preprocessed CrossDocked manifold dataset.
28
- - `crossdocked_pocket10_pose_w_manifold_data_split.pt` β€” train/validation/test split used by NucleusDiff.
29
- - `crossdocked_v1.1_rmsd1.0.tar.gz` β€” filtered CrossDocked data.
30
- - `split_by_name.pt` β€” reference CrossDocked split.
31
- - `test_set.zip` β€” protein test set used for docking evaluation.
32
- - `real_world.zip` β€” therapeutic-target evaluation data.
33
- - `affinity_info.pkl` β€” affinity metadata.
34
- - `test_vina_crossdock_dict.pkl` β€” CrossDocked Vina evaluation metadata.
35
 
36
- ## Download
 
 
 
 
 
 
37
 
38
  Download only the pretrained model:
39
 
@@ -51,13 +99,22 @@ hf download LiangYan3612/NucleusDiff \
51
  --local-dir ./NucleusDiff_artifacts
52
  ```
53
 
54
- See the [GitHub README](https://github.com/yanliang3612/NucleusDiff#readme) for installation, training, inference, and evaluation instructions.
 
 
 
 
 
 
 
 
 
55
 
56
- ## License and data provenance
57
 
58
- The NucleusDiff source code is released under the MIT License. Included data artifacts are mirrors of the files used by the project and may remain subject to the terms of their original data sources.
59
 
60
- ## Citation
61
 
62
  ```bibtex
63
  @article{liu2025manifold,
 
7
  - molecule-generation
8
  - chemistry
9
  ---
10
+ <h1 align="center">NucleusDiff</h1>
11
+
12
+ <h3 align="center">
13
+ Manifold-Constrained Nucleus-Level Denoising Diffusion Model<br />
14
+ for Structure-Based Drug Design
15
+ </h3>
16
+
17
+ <p align="center">
18
+ <strong>Official pretrained checkpoint and data artifacts for the PNAS 2025 paper.</strong>
19
+ </p>
20
+
21
+ <p align="center">
22
+ <a href="https://www.caltech.edu/about/news/new-ai-model-for-drug-design-brings-more-physics-to-bear-in-predictions"><img src="https://img.shields.io/badge/Caltech-News-FF6C0C" alt="Caltech News" /></a>
23
+ <a href="https://yanliang3612.github.io/NucleusDiff/"><img src="https://img.shields.io/badge/Project-Page-0A66C2?logo=githubpages&amp;logoColor=white" alt="Project Page" /></a>
24
+ <a href="https://www.pnas.org/doi/10.1073/pnas.2415666122"><img src="https://img.shields.io/badge/Paper-PNAS-B31B1B" alt="PNAS Paper" /></a>
25
+ <a href="https://arxiv.org/abs/2409.10584"><img src="https://img.shields.io/badge/arXiv-2409.10584-B31B1B?logo=arxiv&amp;logoColor=white" alt="arXiv" /></a>
26
+ <a href="https://github.com/yanliang3612/NucleusDiff"><img src="https://img.shields.io/badge/GitHub-Source_Code-181717?logo=github&amp;logoColor=white" alt="Source code" /></a>
27
+ <a href="https://doi.org/10.5281/zenodo.17093932"><img src="https://img.shields.io/badge/DOI-Zenodo-1682D4?logo=zenodo&amp;logoColor=white" alt="Zenodo DOI" /></a>
28
+ <a href="https://join.slack.com/t/matdiscoverai/shared_invite/zt-32kktcuk0-XaaJT2P9qZTfNdaCzJUGAg"><img src="https://img.shields.io/badge/Slack-Join_SciGenAI-4A154B?logo=slack&amp;logoColor=white" alt="Join SciGenAI on Slack" /></a>
29
+ </p>
30
+
31
+ <p align="center">
32
+ <a href="https://join.slack.com/t/matdiscoverai/shared_invite/zt-32kktcuk0-XaaJT2P9qZTfNdaCzJUGAg">
33
+ <img src="https://readme-typing-svg.demolab.com?font=Inter&amp;weight=700&amp;size=18&amp;pause=1200&amp;color=0A66C2&amp;center=true&amp;vCenter=true&amp;width=900&amp;lines=Official+NucleusDiff+model+%26+data+artifacts;Physics-informed+diffusion+for+structure-based+drug+design;Join+SciGenAI+for+Q%26A%2C+collaboration+%26+code+contributions" alt="NucleusDiff model, data, and community" />
34
+ </a>
35
+ </p>
36
+
37
+ <p align="center">
38
+ Shengchao Liu<sup>*</sup>, Liang Yan<sup>*</sup>, Weitao Du, Weiyang Liu, Zhuoxinran Li, Hongyu Guo,<br />
39
+ Christian Borgs, Jennifer Chayes, Anima Anandkumar
40
+ </p>
41
+
42
+ <p align="center">
43
+ <strong>Proceedings of the National Academy of Sciences (PNAS), 2025</strong><br />
44
+ <sup>*</sup>Equal contribution
45
+ </p>
46
 
47
+ ---
48
+
49
+ ## ✨ Overview
50
+
51
+ NucleusDiff is a physics-informed diffusion model for structure-based drug design. It constrains generated atomic nuclei with sampled points on electron-cloud manifolds, incorporating van der Waals spatial boundaries to reduce atomic collisions while preserving strong binding affinity.
52
+
53
+ This Hugging Face repository is the official mirror for the pretrained checkpoint and project data artifacts. For installation, training, inference, and evaluation, see the [NucleusDiff source repository](https://github.com/yanliang3612/NucleusDiff#readme).
54
 
55
+ ## πŸ“¦ Repository Contents
 
 
 
56
 
57
+ | Resource | Location | Description |
58
+ |---|---|---|
59
+ | 🧠 Pretrained model | [`model/`](https://huggingface.co/LiangYan3612/NucleusDiff/tree/main/model) | Official NucleusDiff checkpoint |
60
+ | 🧬 Project data | [`data/`](https://huggingface.co/LiangYan3612/NucleusDiff/tree/main/data) | Training, evaluation, and therapeutic-target artifacts |
61
+ | πŸ’» Implementation | [GitHub](https://github.com/yanliang3612/NucleusDiff) | Source code, configuration, and usage instructions |
62
 
63
+ ### Model
64
 
65
+ - `model/nucleusdiff_pretrained_model.pt` β€” pretrained NucleusDiff checkpoint.
66
 
67
+ ### Data
68
 
69
+ - `data/crossdocked_v1.1_rmsd1.0_pocket10_processed_w_manifold_data_version.lmdb` β€” preprocessed CrossDocked manifold dataset.
70
+ - `data/crossdocked_pocket10_pose_w_manifold_data_split.pt` β€” train/validation/test split used by NucleusDiff.
71
+ - `data/crossdocked_v1.1_rmsd1.0.tar.gz` β€” filtered CrossDocked data.
72
+ - `data/split_by_name.pt` β€” reference CrossDocked split.
73
+ - `data/test_set.zip` β€” protein test set used for docking evaluation.
74
+ - `data/real_world.zip` β€” therapeutic-target evaluation data.
75
+ - `data/affinity_info.pkl` β€” affinity metadata.
76
+ - `data/test_vina_crossdock_dict.pkl` β€” CrossDocked Vina evaluation metadata.
77
 
78
+ ## ⬇️ Download
79
+
80
+ Install or update the Hugging Face CLI:
81
+
82
+ ```bash
83
+ pip install -U huggingface_hub
84
+ ```
85
 
86
  Download only the pretrained model:
87
 
 
99
  --local-dir ./NucleusDiff_artifacts
100
  ```
101
 
102
+ Download the complete model-and-data snapshot:
103
+
104
+ ```bash
105
+ hf download LiangYan3612/NucleusDiff \
106
+ --local-dir ./NucleusDiff_artifacts
107
+ ```
108
+
109
+ ## πŸ’¬ Community
110
+
111
+ Join the [SciGenAI Slack community](https://join.slack.com/t/matdiscoverai/shared_invite/zt-32kktcuk0-XaaJT2P9qZTfNdaCzJUGAg) for the dedicated NucleusDiff channel, real-time questions, code contributions, pull requests, and collaboration across generative AI for science.
112
 
113
+ ## πŸ“œ License and Data Provenance
114
 
115
+ The NucleusDiff source code is released under the [MIT License](https://github.com/yanliang3612/NucleusDiff/blob/main/LICENSE). Included data artifacts are mirrors of the files used by the project and may remain subject to the terms of their original data sources.
116
 
117
+ ## πŸ“– Citation
118
 
119
  ```bibtex
120
  @article{liu2025manifold,