Update README.md
Browse files
README.md
CHANGED
@@ -22,14 +22,15 @@ The OMat24 dataset contains a mix of single point calculations of non-equilibriu
|
|
22 |
structural relaxations. The dataset contains structures labeled with total energy (eV), forces (eV/A)
|
23 |
and stress (eV/A^3). The dataset is provided in ASE DB compatible lmdb files.
|
24 |
|
25 |
-
|
|
|
|
|
26 |
1. The splits do not contain any structure that has a protostructure label present in the initial or relaxed
|
27 |
structures of the WBM dataset.
|
28 |
2. The splits do not include any structure that was generated starting from an Alexandria relaxed structure with
|
29 |
protostructure lable in the intitial or relaxed structures of the WBM datset.
|
30 |
|
31 |
-
|
32 |
-
##### Train
|
33 |
| Sub-dataset | Size | Download |
|
34 |
| :-----: | :--: | :------: |
|
35 |
| rattled-1000 | 11,388,510 | [rattled-1000.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/train/rattled-1000.tar.gz) |
|
@@ -45,21 +46,23 @@ We provide two splits - train and val. Each split is comprised of several subdat
|
|
45 |
| rattled-relax | 9,433,303 | [rattled-relax.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/train/rattled-relax.tar.gz) |
|
46 |
| Total | 100,824,585 | - |
|
47 |
|
48 |
-
#####
|
|
|
|
|
49 |
| Sub-dataset | Size | Download |
|
50 |
| :-----: | :--: | :------: |
|
51 |
-
| rattled-1000 |
|
52 |
-
| rattled-1000-subsampled |
|
53 |
-
| rattled-500 |
|
54 |
-
| rattled-500-subsampled |
|
55 |
-
| rattled-300 |
|
56 |
-
| rattled-300-subsampled |
|
57 |
-
| aimd-from-PBE-1000-npt |
|
58 |
-
| aimd-from-PBE-1000-nvt |
|
59 |
-
| aimd-from-PBE-3000-npt |
|
60 |
-
| aimd-from-PBE-3000-nvt |
|
61 |
-
| rattled-relax |
|
62 |
-
| Total |
|
63 |
|
64 |
### sAlex Dataset
|
65 |
We also provide the sAlex dataset used for fine-tuning of our OMat models. sAlex is a subsampled, Matbench-Discovery compliant, version of the original [Alexandria](https://alexandria.icams.rub.de/).
|
@@ -67,8 +70,8 @@ sAlex was created by removing structures matched in WBM and only sampling struct
|
|
67 |
please see the manuscript.
|
68 |
| Dataset | Split | Size | Download |
|
69 |
| :-----: | :---: | :--: | :------: |
|
70 |
-
| sAlex | train | 10,447,765 | [train.tar.gz](dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/sAlex/train.tar.gz) |
|
71 |
-
| sAlex | val | 553,218 | [val.tar.gz](dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/sAlex/val.tar.gz) |
|
72 |
|
73 |
## How to read the data
|
74 |
The OMat24 and sAlex datasets can be accessed with the [fairchem](https://github.com/FAIR-Chem/fairchem) library. This package can be installed with:
|
@@ -108,6 +111,13 @@ dataset = AseDBDataset(config=dict(src=dataset_paths, **config_kwargs))
|
|
108 |
```
|
109 |
To read all of the OMat24 training or validations splits simply pass the paths to all subdatasets.
|
110 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
111 |
## Citation
|
112 |
|
113 |
The OMat24 dataset is licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/legalcode). If you use this work, please cite:
|
|
|
22 |
structural relaxations. The dataset contains structures labeled with total energy (eV), forces (eV/A)
|
23 |
and stress (eV/A^3). The dataset is provided in ASE DB compatible lmdb files.
|
24 |
|
25 |
+
We provide two splits - train and validation. Each split is comprised of several subdatasets based on the different input generation strategies, see paper for more details.
|
26 |
+
|
27 |
+
The OMat24 train and validation splits are fully compatible with the Matbench Discovery benchmark test set.
|
28 |
1. The splits do not contain any structure that has a protostructure label present in the initial or relaxed
|
29 |
structures of the WBM dataset.
|
30 |
2. The splits do not include any structure that was generated starting from an Alexandria relaxed structure with
|
31 |
protostructure lable in the intitial or relaxed structures of the WBM datset.
|
32 |
|
33 |
+
##### <ins> Train </ins>
|
|
|
34 |
| Sub-dataset | Size | Download |
|
35 |
| :-----: | :--: | :------: |
|
36 |
| rattled-1000 | 11,388,510 | [rattled-1000.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/train/rattled-1000.tar.gz) |
|
|
|
46 |
| rattled-relax | 9,433,303 | [rattled-relax.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/train/rattled-relax.tar.gz) |
|
47 |
| Total | 100,824,585 | - |
|
48 |
|
49 |
+
##### <ins> Validation </ins>
|
50 |
+
Models were evaluated on a ~1M subset for training efficiency. We provide that set below.
|
51 |
+
|
52 |
| Sub-dataset | Size | Download |
|
53 |
| :-----: | :--: | :------: |
|
54 |
+
| rattled-1000 | 122,937 | [rattled-1000.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-1000.tar.gz) |
|
55 |
+
| rattled-1000-subsampled | 41,786 | [rattled-1000-subsampled.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-1000-subsampled.tar.gz) |
|
56 |
+
| rattled-500 | 75,167 | [rattled-500.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-500.tar.gz) |
|
57 |
+
| rattled-500-subsampled | 43,068 | [rattled-500-subsampled.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-500-subsampled.tar.gz) |
|
58 |
+
| rattled-300 | 68,593 | [rattled-300.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-300.tar.gz) |
|
59 |
+
| rattled-300-subsampled | 37,393 | [rattled-300-subsampled.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-300-subsampled.tar.gz) |
|
60 |
+
| aimd-from-PBE-1000-npt | 223,574 | [aimd-from-PBE-1000-npt.tar.gz](hhtps://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/aimd-from-PBE-1000-npt.tar.gz) |
|
61 |
+
| aimd-from-PBE-1000-nvt | 215,589 | [aimd-from-PBE-1000-nvt.tar.gz](hhtps://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/aimd-from-PBE-1000-nvt.tar.gz) |
|
62 |
+
| aimd-from-PBE-3000-npt | 65,244 | [aimd-from-PBE-3000-npt.tar.gz](hhtps://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/aimd-from-PBE-3000-npt.tar.gz) |
|
63 |
+
| aimd-from-PBE-3000-nvt | 84,063 | [aimd-from-PBE-3000-npt.tar.gz](hhtps://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/aimd-from-PBE-3000-npt.tar.gz) |
|
64 |
+
| rattled-relax | 99,968 | [rattled-relax.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/omat/val/rattled-relax.tar.gz) |
|
65 |
+
| Total | 1,077,382 | - |
|
66 |
|
67 |
### sAlex Dataset
|
68 |
We also provide the sAlex dataset used for fine-tuning of our OMat models. sAlex is a subsampled, Matbench-Discovery compliant, version of the original [Alexandria](https://alexandria.icams.rub.de/).
|
|
|
70 |
please see the manuscript.
|
71 |
| Dataset | Split | Size | Download |
|
72 |
| :-----: | :---: | :--: | :------: |
|
73 |
+
| sAlex | train | 10,447,765 | [train.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/sAlex/train.tar.gz) |
|
74 |
+
| sAlex | val | 553,218 | [val.tar.gz](https://dl.fbaipublicfiles.com/opencatalystproject/data/omat/241018/sAlex/val.tar.gz) |
|
75 |
|
76 |
## How to read the data
|
77 |
The OMat24 and sAlex datasets can be accessed with the [fairchem](https://github.com/FAIR-Chem/fairchem) library. This package can be installed with:
|
|
|
111 |
```
|
112 |
To read all of the OMat24 training or validations splits simply pass the paths to all subdatasets.
|
113 |
|
114 |
+
## Support
|
115 |
+
If you run into any issues regarding feel free to post your questions or comments on any of the following platforms:
|
116 |
+
|
117 |
+
- [Github Issues](https://github.com/FAIR-Chem/fairchem/issues)
|
118 |
+
- [Discussion Board](https://discuss.opencatalystproject.org/)
|
119 |
+
|
120 |
+
|
121 |
## Citation
|
122 |
|
123 |
The OMat24 dataset is licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/legalcode). If you use this work, please cite:
|