Add concise STRUCTURES25 model card
#1
by christofgehrig - opened
README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: cc0-1.0
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc0-1.0
|
| 3 |
+
library_name: pytorch
|
| 4 |
+
language:
|
| 5 |
+
- en
|
| 6 |
+
tags:
|
| 7 |
+
- chemistry
|
| 8 |
+
- density-functional-theory
|
| 9 |
+
- orbital-free-dft
|
| 10 |
+
- electron-density
|
| 11 |
+
- graph-neural-network
|
| 12 |
+
- equivariant
|
| 13 |
+
- pytorch-lightning
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
<p align="center">
|
| 17 |
+
<a href="https://sciai-lab.org/"><img src="https://sciai-lab.org/images/logo.svg" alt="SciAI Lab" width="72" style="background-color: white; padding: 8px; border-radius: 12px;"></a>
|
| 18 |
+
</p>
|
| 19 |
+
|
| 20 |
+
# STRUCTURES25
|
| 21 |
+
|
| 22 |
+
**Machine-learned orbital-free density functional theory**
|
| 23 |
+
|
| 24 |
+
Pretrained models for optimizing molecular electron densities and energies, developed by **SciAI Lab, Heidelberg University**. Equivariant graph neural networks learn the kinetic-plus-exchange-correlation energy functional from reference DFT data.
|
| 25 |
+
|
| 26 |
+
[GitHub](https://github.com/sciai-lab/structures25) · [Documentation](https://sciai-lab.github.io/structures25/) · [Paper](https://doi.org/10.1021/jacs.5c06219) · [Data](https://doi.org/10.5061/dryad.0cfxpnwcs)
|
| 27 |
+
|
| 28 |
+

|
| 29 |
+
|
| 30 |
+
## Available models
|
| 31 |
+
|
| 32 |
+
| Model | Training molecules | CLI name |
|
| 33 |
+
| --- | --- | --- |
|
| 34 |
+
| [QM9](https://huggingface.co/sciai-lab/structures25/tree/main/trained-on-qm9) | QM9 | `str25_qm9` |
|
| 35 |
+
| [QMugs](https://huggingface.co/sciai-lab/structures25/tree/main/trained-on-qmugs) | Small-molecule QMugs subset | `str25_qmugs` |
|
| 36 |
+
|
| 37 |
+
Both checkpoints support **H, C, N, O, and F** and use training data augmented with perturbed external potentials. Intended for molecular OF-DFT research within the chemical scope of the training data; accuracy and convergence on new systems require validation.
|
| 38 |
+
|
| 39 |
+
## Get started
|
| 40 |
+
|
| 41 |
+
Follow the [installation and setup guide](https://sciai-lab.github.io/structures25/installation.html) to install `mldft`, download the models, and configure their locations. Then run:
|
| 42 |
+
|
| 43 |
+
```bash
|
| 44 |
+
mldft example.xyz --model str25_qm9
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
Use `--model str25_qmugs` for the QMugs checkpoint. See the [usage guide](https://sciai-lab.github.io/structures25/usage.html) for options and the [replication guide](https://github.com/sciai-lab/structures25/blob/main/REPLICATION_GUIDE.md) for technical details and benchmarks.
|
| 48 |
+
|
| 49 |
+
## Reference
|
| 50 |
+
|
| 51 |
+
Remme et al., **Stable and Accurate Orbital-Free Density Functional Theory Powered by Machine Learning**, *J. Am. Chem. Soc.* **147**, 28851–28859 (2025). [DOI](https://doi.org/10.1021/jacs.5c06219) · [BibTeX](https://sciai-lab.github.io/structures25/#structures25-documentation)
|