Update README.md
Browse files
README.md
CHANGED
@@ -329,12 +329,6 @@ configs:
|
|
329 |
path: non_compatible/train-*
|
330 |
---
|
331 |
|
332 |
-
# ⚠️ Pre-release Notice
|
333 |
-
|
334 |
-
This dataset is currently a pre-release and undergoing validation.
|
335 |
-
While we’ve shared this early version to support initial exploration and feedback, we are still actively running quality checks.
|
336 |
-
Please proceed with caution and double-check any critical results drawn from this data.
|
337 |
-
A formal release will follow once validation is complete.
|
338 |
|
339 |
Note: For PBE we are in the process of providing a precomputed energy_corrected scheme based on [Materials Project 2020 Compatibility Scheme](https://www.nature.com/articles/s41598-021-94550-5)
|
340 |
|
@@ -378,6 +372,8 @@ dataset = load_dataset('LeMaterial/LeMat-Traj', 'compatible_pbe')
|
|
378 |
| **magnetic_moments** | Sequence[Floats] | The magnetic moment per site given in µB. | |
|
379 |
| **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. | |
|
380 |
| **functional** | String, either ‘pbe’, ‘pbesol’ or ‘scan’ | What functional was used to calculate the data point in the row. | |
|
|
|
|
|
381 |
| **cross_compatibility** | Boolean | Whether or not this data can be mixed with other rows from a DFT calculation parameter perspective. More information on our approach below. | |
|
382 |
| **relaxation_step** | Integer | The current step along the trajectory. For double relaxation calculations for example, where the previous calculation took 3 total steps, the first image of the next relaxation should be relaxation_step=3. | |
|
383 |
| **relaxation_number** | Integer | The step along the trajectory for example for Alexandria with triple relaxations, this might be relaxation_step=0, 1 or 2. | |
|
@@ -389,28 +385,6 @@ To better support the diverse communities that may utilize this dataset, we are
|
|
389 |
- **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.
|
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 |
-
| **Database** | **Number of trajectories** | **Number of structures*** |
|
394 |
-
| --- | --- | --- |
|
395 |
-
| Materials Project | 46,632 | 725,048 |
|
396 |
-
| Alexandria | 2,613,109 | 114,629,913 |
|
397 |
-
| OQMD | 995,013 | 432,139
|
398 |
-
|
399 |
-
### `compatible_pbesol`
|
400 |
-
| **Database** | **Number of trajectories** | **Number of structures*** |
|
401 |
-
| --- | --- | --- |
|
402 |
-
| Alexandria | 205,837 | 5,276,643 |
|
403 |
-
|
404 |
-
### `compatible_scan`
|
405 |
-
| **Database** | **Number of trajectories** | **Number of structures*** |
|
406 |
-
| --- | --- | --- |
|
407 |
-
| Materials Project | 5,640 | 155,923 |
|
408 |
-
|
409 |
-
### `non_compatible`
|
410 |
-
| **Database** | **Number of trajectories** | **Number of structures*** |
|
411 |
-
| --- | --- | --- |
|
412 |
-
| OQMD | 181,237 | 412,623 |
|
413 |
-
|
414 |
|
415 |
## Method for compatibility compliance
|
416 |
|
|
|
329 |
path: non_compatible/train-*
|
330 |
---
|
331 |
|
|
|
|
|
|
|
|
|
|
|
|
|
332 |
|
333 |
Note: For PBE we are in the process of providing a precomputed energy_corrected scheme based on [Materials Project 2020 Compatibility Scheme](https://www.nature.com/articles/s41598-021-94550-5)
|
334 |
|
|
|
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. | |
|
375 |
+
| **space_group_it_number** | Integer | The international space group of the bulk structure as computed by Moyopy | ✅ |
|
376 |
+
| **id** | String | The id of the frame containing a trajectory number, functional and relaxation step | |
|
377 |
| **cross_compatibility** | Boolean | Whether or not this data can be mixed with other rows from a DFT calculation parameter perspective. More information on our approach below. | |
|
378 |
| **relaxation_step** | Integer | The current step along the trajectory. For double relaxation calculations for example, where the previous calculation took 3 total steps, the first image of the next relaxation should be relaxation_step=3. | |
|
379 |
| **relaxation_number** | Integer | The step along the trajectory for example for Alexandria with triple relaxations, this might be relaxation_step=0, 1 or 2. | |
|
|
|
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 |
|