Spaces:
Runtime error
Runtime error
Commit
·
800e1b6
1
Parent(s):
07353a2
Update model_cards/article.md
Browse files- model_cards/article.md +42 -35
model_cards/article.md
CHANGED
|
@@ -4,15 +4,15 @@
|
|
| 4 |
|
| 5 |
### Property
|
| 6 |
The supported properties are:
|
| 7 |
-
- `Metal NonMetal Classifier`:
|
| 8 |
-
- `Metal Semiconductor Classifier`: Classifying whether a
|
| 9 |
-
- `Poisson Ratio`:
|
| 10 |
-
- `Shear Moduli
|
| 11 |
-
- `Bulk Moduli
|
| 12 |
-
- `Fermi Energy
|
| 13 |
-
- `Band Gap
|
| 14 |
-
- `Absolute Energy
|
| 15 |
-
- `Formation Energy
|
| 16 |
|
| 17 |
|
| 18 |
### Input file for crystal model
|
|
@@ -24,46 +24,45 @@ The file with information about the metal. Dependent on the property you want to
|
|
| 24 |
|
| 25 |
# Model card - CGCNN
|
| 26 |
|
| 27 |
-
**Model Details**:
|
| 28 |
|
| 29 |
-
**Developers**:
|
| 30 |
|
| 31 |
**Distributors**: Original authors' code wrapped and distributed by GT4SD Team (2023) from IBM Research.
|
| 32 |
|
| 33 |
-
**Model date**:
|
| 34 |
|
| 35 |
**Algorithm version**: Models trained and distributed by the original authors.
|
| 36 |
-
- **
|
| 37 |
-
- **
|
| 38 |
-
- **
|
| 39 |
-
- **
|
| 40 |
-
- **
|
| 41 |
-
- **
|
| 42 |
-
- **
|
| 43 |
-
- **
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
**Model type**: A Transformer-based language model that is trained on alphanumeric sequence to simultaneously perform sequence regression or conditional sequence generation.
|
| 47 |
|
| 48 |
**Information about training algorithms, parameters, fairness constraints or other applied approaches, and features**:
|
| 49 |
-
|
| 50 |
|
| 51 |
**Paper or other resource for more information**:
|
| 52 |
-
The [
|
| 53 |
|
| 54 |
**License**: MIT
|
| 55 |
|
| 56 |
-
**Where to send questions or comments about the model**: Open an issue on [
|
| 57 |
|
| 58 |
-
**Intended Use. Use cases that were envisioned during development**:
|
| 59 |
|
| 60 |
-
**Primary intended uses/users**: Researchers
|
| 61 |
|
| 62 |
**Out-of-scope use cases**: Production-level inference, producing molecules with harmful properties.
|
| 63 |
|
| 64 |
-
**Factors**:
|
| 65 |
|
| 66 |
-
**Metrics**:
|
| 67 |
|
| 68 |
**Datasets**: Different ones, as described under **Algorithm version**.
|
| 69 |
|
|
@@ -82,10 +81,18 @@ ToDo...
|
|
| 82 |
# Citation
|
| 83 |
|
| 84 |
```bib
|
| 85 |
-
@article{
|
| 86 |
-
title={
|
| 87 |
-
author={
|
| 88 |
-
journal={
|
| 89 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 90 |
}
|
| 91 |
```
|
|
|
|
| 4 |
|
| 5 |
### Property
|
| 6 |
The supported properties are:
|
| 7 |
+
- `Metal NonMetal Classifier`: Classifying whether a crystal could be metal or nonmetal using a [RandomForest classifier](https://www.nature.com/articles/s41524-022-00850-3)
|
| 8 |
+
- `Metal Semiconductor Classifier`: Classifying whether a crystal could be metal or semiconductor using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 9 |
+
- `Poisson Ratio`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 10 |
+
- `Shear Moduli`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 11 |
+
- `Bulk Moduli`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 12 |
+
- `Fermi Energy`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 13 |
+
- `Band Gap`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 14 |
+
- `Absolute Energy`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 15 |
+
- `Formation Energy`: Predicted using the [CGCNN framework](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301).
|
| 16 |
|
| 17 |
|
| 18 |
### Input file for crystal model
|
|
|
|
| 24 |
|
| 25 |
# Model card - CGCNN
|
| 26 |
|
| 27 |
+
**Model Details**: Eight CGCNN models trained to predict various properties for crystals.
|
| 28 |
|
| 29 |
+
**Developers**: [CGCNN's](https://github.com/txie-93/cgcnn) developers.
|
| 30 |
|
| 31 |
**Distributors**: Original authors' code wrapped and distributed by GT4SD Team (2023) from IBM Research.
|
| 32 |
|
| 33 |
+
**Model date**: 2018.
|
| 34 |
|
| 35 |
**Algorithm version**: Models trained and distributed by the original authors.
|
| 36 |
+
- **Metal Semiconductor Classifier**: Model trained to classify whether a crystal could be metal or semiconductor using instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals..
|
| 37 |
+
- **Poisson Ratio**: Model to predict the Poisson ratio trained on 2041 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals.
|
| 38 |
+
- **Shear Moduli**: Model to predict the Shear moduli trained on 2041 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit log(GPa).
|
| 39 |
+
- **Bulk Moduli**: Model to predict the Bulk moduli trained on 2041 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit log(GPa).
|
| 40 |
+
- **Fermi Energy**: Model to predict the Fermi energy trained on 28046 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit eV.
|
| 41 |
+
- **Band Gap**: Model to predict the Band Gap trained on 16458 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit eV.
|
| 42 |
+
- **Absolute Energy**: Model to predict the Absolute energy trained on 28046 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit eV/atom.
|
| 43 |
+
- **Formation Energy**: Model to predict the formation energy trained on 28046 instances from this [database](https://aip.scitation.org/doi/10.1063/1.4812323) that includes a diverse set of inorganic crystals ranging from simple metals to complex minerals. Unit eV/atom.
|
| 44 |
+
|
| 45 |
+
**Model type**: Crystal Graph Convolutional Neural Networks (CGCNN) that take an arbitary crystal structure to predict material properties.
|
|
|
|
| 46 |
|
| 47 |
**Information about training algorithms, parameters, fairness constraints or other applied approaches, and features**:
|
| 48 |
+
See the [CGCNN](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301) paper for details.
|
| 49 |
|
| 50 |
**Paper or other resource for more information**:
|
| 51 |
+
The [CGCNN](https://link.aps.org/doi/10.1103/PhysRevLett.120.145301) paper. See the [source code](https://github.com/txie-93/cgcnn) for details.
|
| 52 |
|
| 53 |
**License**: MIT
|
| 54 |
|
| 55 |
+
**Where to send questions or comments about the model**: Open an issue on [CGCNN](https://github.com/txie-93/cgcnn) repo.
|
| 56 |
|
| 57 |
+
**Intended Use. Use cases that were envisioned during development**: Materials research.
|
| 58 |
|
| 59 |
+
**Primary intended uses/users**: Researchers using the model for model comparison or research exploration purposes.
|
| 60 |
|
| 61 |
**Out-of-scope use cases**: Production-level inference, producing molecules with harmful properties.
|
| 62 |
|
| 63 |
+
**Factors**: N.A.
|
| 64 |
|
| 65 |
+
**Metrics**: N.A.
|
| 66 |
|
| 67 |
**Datasets**: Different ones, as described under **Algorithm version**.
|
| 68 |
|
|
|
|
| 81 |
# Citation
|
| 82 |
|
| 83 |
```bib
|
| 84 |
+
@article{PhysRevLett.120.145301,
|
| 85 |
+
title = {Crystal Graph Convolutional Neural Networks for an Accurate and Interpretable Prediction of Material Properties},
|
| 86 |
+
author = {Xie, Tian and Grossman, Jeffrey C.},
|
| 87 |
+
journal = {Phys. Rev. Lett.},
|
| 88 |
+
volume = {120},
|
| 89 |
+
issue = {14},
|
| 90 |
+
pages = {145301},
|
| 91 |
+
numpages = {6},
|
| 92 |
+
year = {2018},
|
| 93 |
+
month = {Apr},
|
| 94 |
+
publisher = {American Physical Society},
|
| 95 |
+
doi = {10.1103/PhysRevLett.120.145301},
|
| 96 |
+
url = {https://link.aps.org/doi/10.1103/PhysRevLett.120.145301}
|
| 97 |
}
|
| 98 |
```
|