gpwolfe commited on
Commit
0fdc69b
·
verified ·
1 Parent(s): 7036955

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -8
README.md CHANGED
@@ -10,35 +10,46 @@ pinned: false
10
  # Open Materials Generation (OMatG)
11
  ## About
12
 
13
- OMatG is a generative model for crystal structure prediction and de novo generation of inorganic crystals.
14
  This repository hosts our model checkpoints and benchmark datasets.
15
 
 
 
16
  ## Models
17
 
 
 
 
 
 
 
18
 
19
 
20
  ### Crystal Structure Prediction (CSP)
21
- |model |best checkpoints | match rate - full/valid (%)| RMSE (full/valid) | notes |
22
  |:------------:|:---------------:|:--------------------------:|:-----------------:|:------|
23
- |[Alex-MP-20-CSP](https://huggingface.co/OMatG/Alex-MP-20-CSP)|Trig SDE Gamma |72.50 / 64.71 |0.1261 / 0.1251 |Predict inorganic crystal structures of compositions with **up to 20 atoms** per unit cell. **Largest training set; recommended over MP-20-CSP**.
24
- |[MP-20-CSP](https://huggingface.co/OMatG/MP-20-CSP) |Linear ODE |69.83 / 63.75 |0.0741 / 0.0720 |Predict inorganic crystal structures of compositions with **up to 20 atoms** per unit cell.|20-CSP.
25
- |[MPTS-52-CSP(https://huggingface.co/OMatG/MPTS-52-CSP)] |Linear ODE |27.38 / 25.15 |0.1970 / 0.1931 |Predict inorganic crystal structures of compositions with **up to 52 atoms** per unit cell. Not recommended for general use.|
26
- |[perov-5-CSP](https://huggingface.co/OMatG/perov-5-CSP) |VPSBD ODE |60.18 / 52.97 |0.2510 / 0.2337 |Predict perovskite structures with **exactly 5 atoms** per unit cell. Not recommended for general use.|
27
 
28
 
29
  ### _de novo_ Generation (DNG)
30
  |model |best checkpoints | S.U.N rate (%)| RMSD | notes |
31
  |:---------:|:---------------:|:-------------:|:-----:|:----------------------------------------------------------------------:|
32
- |[MP-20-DNG](https://huggingface.co/OMatG/MP-20-DNG) |Linear SDE Gamma |22.07 |0.6148 |Generate _de novo_ crystal structures with up to 20 atoms per unit cell |
33
 
 
34
 
35
  ## Citation
36
  Please cite [our paper on OpenReview](https://openreview.net/forum?id=gHGrzxFujU) if using our models or datasets.
37
 
 
 
38
  ## Links
39
  [OMatG on GitHub](https://github.com/FERMat-ML/OMatG): See this repository for installation, training and usage instructions.
40
  [KIM Initiative](https://kim-initiative.org/): Knowledgebase of Interatomic Models. Tools and resources for researchers in materials science and chemistry.
41
  [Fermat-ML on GitHub](https://github.com/FERMat-ML): Foundational Representation of Materials. Machine learning foundation model for materials and chemistry discovery.
42
-
43
 
44
 
 
10
  # Open Materials Generation (OMatG)
11
  ## About
12
 
13
+ OMatG is a generative model for crystal structure prediction and _de novo_ generation of inorganic crystals.
14
  This repository hosts our model checkpoints and benchmark datasets.
15
 
16
+ ---
17
+
18
  ## Models
19
 
20
+ Each of our models have been trained with a variety of stochastic interpolants.
21
+ Checkpoints for each are included in subdirectories within each model repository.
22
+
23
+ The tables below indicate the recommended checkpoints for each model, as well as the suggested use case.
24
+
25
+ [**Try our models live at OMatGenerate**](https://omatgenerate.users.hsrn.nyu.edu/)
26
 
27
 
28
  ### Crystal Structure Prediction (CSP)
29
+ |model |best checkpoints | match rate (full/valid)(%)| RMSE (full/valid) | notes |
30
  |:------------:|:---------------:|:--------------------------:|:-----------------:|:------|
31
+ |[**Alex-MP-20-CSP**](https://huggingface.co/OMatG/Alex-MP-20-CSP)|Trig SDE Gamma |72.50 / 64.71 |0.1261 / 0.1251 |Predict inorganic crystal structures of compositions with **up to 20 atoms** per unit cell. **Largest training set; recommended over MP-20-CSP**.
32
+ |[**MP-20-CSP**](https://huggingface.co/OMatG/MP-20-CSP) |Linear ODE |69.83 / 63.75 |0.0741 / 0.0720 |Predict inorganic crystal structures of compositions with **up to 20 atoms** per unit cell.|20-CSP.
33
+ |[**MPTS-52-CSP**](https://huggingface.co/OMatG/MPTS-52-CSP) |Linear ODE |27.38 / 25.15 |0.1970 / 0.1931 |Predict inorganic crystal structures of compositions with **up to 52 atoms** per unit cell. Not recommended for general use.|
34
+ |[**perov-5-CSP**](https://huggingface.co/OMatG/perov-5-CSP) |VPSBD ODE |60.18 / 52.97 |0.2510 / 0.2337 |Predict perovskite structures with **exactly 5 atoms** per unit cell. Not recommended for general use.|
35
 
36
 
37
  ### _de novo_ Generation (DNG)
38
  |model |best checkpoints | S.U.N rate (%)| RMSD | notes |
39
  |:---------:|:---------------:|:-------------:|:-----:|:----------------------------------------------------------------------:|
40
+ |[**MP-20-DNG**](https://huggingface.co/OMatG/MP-20-DNG) |Linear SDE Gamma |22.07 |0.6148 |Generate _de novo_ crystal structures with up to 20 atoms per unit cell |
41
 
42
+ ---
43
 
44
  ## Citation
45
  Please cite [our paper on OpenReview](https://openreview.net/forum?id=gHGrzxFujU) if using our models or datasets.
46
 
47
+ ---
48
+
49
  ## Links
50
  [OMatG on GitHub](https://github.com/FERMat-ML/OMatG): See this repository for installation, training and usage instructions.
51
  [KIM Initiative](https://kim-initiative.org/): Knowledgebase of Interatomic Models. Tools and resources for researchers in materials science and chemistry.
52
  [Fermat-ML on GitHub](https://github.com/FERMat-ML): Foundational Representation of Materials. Machine learning foundation model for materials and chemistry discovery.
53
+ [OMatGenerate](omatgenerate.users.hsrn.nyu.edu): Try our models **live** at OMatGenerate, hosted on New York University's High Speed Research Network.
54
 
55