Update README.md
Browse files
README.md
CHANGED
@@ -369,6 +369,7 @@ dataset = load_dataset('LeMaterial/LeMat-Traj', 'compatible_pbe')
|
|
369 |
| **elements_ratios** | Dictionary | The fractional composition for a given structure in dictionary format. For example a structure with an unreduced composition of Li2O4 would have an entry of `{’Li’:0.3333, ‘O’:0.6667}` | ✅ |
|
370 |
| **stress_tensor** | Sequence[Sequence[Float]], shape = 3x3 | The full 3x3 vector for stress tensor in units of kB. Note: for OQMD stress tensor were given in Voigt notation, and were converted to the full tensor. | |
|
371 |
| **energy** | Float | The uncorrected energy from VASP in eV. | |
|
|
|
372 |
| **magnetic_moments** | Sequence[Floats] | The magnetic moment per site given in µB. | |
|
373 |
| **forces** | Sequence[Sequence[Floats]], shape = 3xN | The force per site, in the proper order of the sites based on other site specific fields for each site in the x, y and z directions, given in eV/A. | |
|
374 |
| **functional** | String, either ‘pbe’, ‘pbesol’ or ‘scan’ | What functional was used to calculate the data point in the row. | |
|
@@ -383,8 +384,45 @@ dataset = load_dataset('LeMaterial/LeMat-Traj', 'compatible_pbe')
|
|
383 |
To better support the diverse communities that may utilize this dataset, we are providing the following subsets of our database:
|
384 |
|
385 |
- **Compatible, PBE (default)**: This subset includes rows filtered to ensure cross-compatibility from a DFT perspective. For details on the filtering methodology, see the section below. Only PBE records are included. We designate this as the default subset to prevent accidental training of models on non-compatible data.
|
|
|
|
|
|
|
386 |
- **All**: This includes all records formatted as described above. **Disclaimer**: Researchers must carefully evaluate the suitability of individual rows for their specific applications.
|
387 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
388 |
|
389 |
## Method for compatibility compliance
|
390 |
|
@@ -402,7 +440,8 @@ The “all” split does not contain any filtering based on this approach, so al
|
|
402 |
We mostly borrowed from research from the Materials Project including research on r2SCAN data curation from [Xu Huang, Bowen Deng, Peichen Zhong, Aaron D. Kaplan, Kristin A. Persson, Gerbrand Ceder](https://www.arxiv.org/abs/2504.05565) and from the ChgNet data curation from [Bowen Deng, Peichen Zhong, KyuJung Jun, Janosh Riebesell, Kevin Han, Christopher J. Bartel & Gerbrand Ceder ](https://www.nature.com/articles/s42256-023-00716-3#Sec11). However we made a key change. The selection criteria includes:
|
403 |
- Within the trajectories frames were discarded if they deviated more than 1eV/atom from the final frame, to ensure that no frames are included which may not be fully converged.
|
404 |
- Where possible to identify, if the electronic SCF test did not converge, we did not include the frame.
|
405 |
-
- We kept structures with missing energy, and forces
|
|
|
406 |
- We did not downsample based on trajectory length or similar structure to try to enhance diversity, rather opting for full trajectory dataset that others can use.
|
407 |
- Because we added data from other databases, we provide compatibility compliance subset as described above.
|
408 |
|
|
|
369 |
| **elements_ratios** | Dictionary | The fractional composition for a given structure in dictionary format. For example a structure with an unreduced composition of Li2O4 would have an entry of `{’Li’:0.3333, ‘O’:0.6667}` | ✅ |
|
370 |
| **stress_tensor** | Sequence[Sequence[Float]], shape = 3x3 | The full 3x3 vector for stress tensor in units of kB. Note: for OQMD stress tensor were given in Voigt notation, and were converted to the full tensor. | |
|
371 |
| **energy** | Float | The uncorrected energy from VASP in eV. | |
|
372 |
+
| **energy_corrected** | Float | For the PBE subset: Materials Project 2020 compatibility scheme across the entire dataset | |
|
373 |
| **magnetic_moments** | Sequence[Floats] | The magnetic moment per site given in µB. | |
|
374 |
| **forces** | Sequence[Sequence[Floats]], shape = 3xN | The force per site, in the proper order of the sites based on other site specific fields for each site in the x, y and z directions, given in eV/A. | |
|
375 |
| **functional** | String, either ‘pbe’, ‘pbesol’ or ‘scan’ | What functional was used to calculate the data point in the row. | |
|
|
|
384 |
To better support the diverse communities that may utilize this dataset, we are providing the following subsets of our database:
|
385 |
|
386 |
- **Compatible, PBE (default)**: This subset includes rows filtered to ensure cross-compatibility from a DFT perspective. For details on the filtering methodology, see the section below. Only PBE records are included. We designate this as the default subset to prevent accidental training of models on non-compatible data.
|
387 |
+
- **Compatible, PBESol**
|
388 |
+
- **Compatible, SCAN**
|
389 |
+
- **Compatible, r2SCAN**
|
390 |
- **All**: This includes all records formatted as described above. **Disclaimer**: Researchers must carefully evaluate the suitability of individual rows for their specific applications.
|
391 |
|
392 |
+
### `compatible_pbe`
|
393 |
+
|
394 |
+
| **Database** | **Number of trajectories** | **Number of structures*** |
|
395 |
+
| --- | --- | --- |
|
396 |
+
| Materials Project | 195,721 | 3,649,785 |
|
397 |
+
| Alexandria | 3,414,074 | 110,804,226 |
|
398 |
+
| OQMD | 135,966 | 264,782 |
|
399 |
+
|
400 |
+
### `compatible_pbesol`
|
401 |
+
|
402 |
+
| **Database** | **Number of trajectories** | **Number of structures*** |
|
403 |
+
| --- | --- | --- |
|
404 |
+
| Materials Project | 39,981 | 309,873 |
|
405 |
+
| Alexandria | 252,791 | 6,099,623 |
|
406 |
+
|
407 |
+
### `compatible_scan`
|
408 |
+
|
409 |
+
| **Database** | **Number of trajectories** | **Number of structures*** |
|
410 |
+
| --- | --- | --- |
|
411 |
+
| Materials Project | 7,756 | 180,528 |
|
412 |
+
|
413 |
+
### `compatible_r2scan`
|
414 |
+
|
415 |
+
| **Database** | **Number of trajectories** | **Number of structures*** |
|
416 |
+
| --- | --- | --- |
|
417 |
+
| Materials Project | 37,888 | 516,576 |
|
418 |
+
|
419 |
+
### `non_compatible`
|
420 |
+
|
421 |
+
| **Database** | **Number of structures*** |
|
422 |
+
| --- | --- |
|
423 |
+
| Materials Project | 546,716 |
|
424 |
+
| Alexandria | 95,869 |
|
425 |
+
| OQMD | 128,816 |
|
426 |
|
427 |
## Method for compatibility compliance
|
428 |
|
|
|
440 |
We mostly borrowed from research from the Materials Project including research on r2SCAN data curation from [Xu Huang, Bowen Deng, Peichen Zhong, Aaron D. Kaplan, Kristin A. Persson, Gerbrand Ceder](https://www.arxiv.org/abs/2504.05565) and from the ChgNet data curation from [Bowen Deng, Peichen Zhong, KyuJung Jun, Janosh Riebesell, Kevin Han, Christopher J. Bartel & Gerbrand Ceder ](https://www.nature.com/articles/s42256-023-00716-3#Sec11). However we made a key change. The selection criteria includes:
|
441 |
- Within the trajectories frames were discarded if they deviated more than 1eV/atom from the final frame, to ensure that no frames are included which may not be fully converged.
|
442 |
- Where possible to identify, if the electronic SCF test did not converge, we did not include the frame.
|
443 |
+
- We have not kept structures with missing energy, and forces. For people wanting to do something similar to OCP's initial structure to relaxed structure (IS2RE) task, this can be added as a separate split.
|
444 |
+
- We kept multiple trajectories for the same material from the Materials Project for the structure optimization tasks that are not deprecated.
|
445 |
- We did not downsample based on trajectory length or similar structure to try to enhance diversity, rather opting for full trajectory dataset that others can use.
|
446 |
- Because we added data from other databases, we provide compatibility compliance subset as described above.
|
447 |
|