Update README.md
Browse files
README.md
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# My-MLIAP-Dataset: Train/Val/Test extxyz for <system/domain>
|
| 2 |
|
| 3 |
-
**Pretty name:**
|
| 4 |
**Tags:** materials-science, atomistic-simulations, extxyz, ase, mliap
|
| 5 |
-
**License:**
|
| 6 |
**Dataset type:** splits (train/val/test)
|
| 7 |
|
| 8 |
## Summary
|
|
@@ -10,13 +22,13 @@ This dataset provides three `.extxyz` splits (train/val/test) for training and b
|
|
| 10 |
|
| 11 |
- **Format:** ASE/EXTXYZ with keys: `REF_energy`, `REF_forces`, `REF_stress`
|
| 12 |
- **Units:** energy (eV), forces (eV/Å), stress (eV/ų)
|
| 13 |
-
- **Systems:**
|
| 14 |
-
- **Provenance:**
|
| 15 |
|
| 16 |
## Files
|
| 17 |
-
- `data/train.extxyz` — <
|
| 18 |
-
- `data/val.extxyz` — <
|
| 19 |
-
- `data/test.extxyz` — <
|
| 20 |
- `index.json` — split counts, checksums, and schema
|
| 21 |
|
| 22 |
### Schema (per-frame)
|
|
@@ -32,9 +44,9 @@ This dataset provides three `.extxyz` splits (train/val/test) for training and b
|
|
| 32 |
```python
|
| 33 |
from huggingface_hub import snapshot_download
|
| 34 |
local_dir = snapshot_download(
|
| 35 |
-
repo_id="
|
| 36 |
repo_type="dataset",
|
| 37 |
-
local_dir="
|
| 38 |
local_dir_use_symlinks=False
|
| 39 |
)
|
| 40 |
```
|
|
@@ -49,7 +61,7 @@ train = read('hf://datasets/<your-username>/my-mliap-dataset/data/train.extxyz',
|
|
| 49 |
```python
|
| 50 |
from huggingface_hub import hf_hub_download
|
| 51 |
path = hf_hub_download(
|
| 52 |
-
repo_id="
|
| 53 |
repo_type="dataset",
|
| 54 |
filename="data/train.extxyz"
|
| 55 |
)
|
|
@@ -63,13 +75,13 @@ train = read(path, ':')
|
|
| 63 |
- Recommended metrics: energy MAE (meV/atom), force MAE (meV/Å), virial/stress MAE (GPa or eV/ų).
|
| 64 |
|
| 65 |
## Provenance & generation
|
| 66 |
-
- **Code:**
|
| 67 |
-
- **Settings:**
|
| 68 |
-
- **MD Sampling:**
|
| 69 |
-
- **Post-processing:**
|
| 70 |
|
| 71 |
## License
|
| 72 |
-
This dataset is released under **
|
| 73 |
|
| 74 |
## How to cite
|
| 75 |
Please cite:
|
|
@@ -80,4 +92,4 @@ Please cite:
|
|
| 80 |
- v1.0.0 — initial release.
|
| 81 |
|
| 82 |
---
|
| 83 |
-
**Contact:**
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
tags:
|
| 5 |
+
- physics
|
| 6 |
+
- materials
|
| 7 |
+
- science
|
| 8 |
+
- chemistry
|
| 9 |
+
pretty_name: LMX Dataset
|
| 10 |
+
size_categories:
|
| 11 |
+
- 10K<n<100K
|
| 12 |
+
---
|
| 13 |
# My-MLIAP-Dataset: Train/Val/Test extxyz for <system/domain>
|
| 14 |
|
| 15 |
+
**Pretty name:** LMX Dataset
|
| 16 |
**Tags:** materials-science, atomistic-simulations, extxyz, ase, mliap
|
| 17 |
+
**License:**
|
| 18 |
**Dataset type:** splits (train/val/test)
|
| 19 |
|
| 20 |
## Summary
|
|
|
|
| 22 |
|
| 23 |
- **Format:** ASE/EXTXYZ with keys: `REF_energy`, `REF_forces`, `REF_stress`
|
| 24 |
- **Units:** energy (eV), forces (eV/Å), stress (eV/ų)
|
| 25 |
+
- **Systems:** Halide-based Solid electrolytes
|
| 26 |
+
- **Provenance:** DFT/MD details: functional, code, cutoffs, k-points, thermostat/barostat, etc.
|
| 27 |
|
| 28 |
## Files
|
| 29 |
+
- `data/train.extxyz` — <1> frames
|
| 30 |
+
- `data/val.extxyz` — <1> frames
|
| 31 |
+
- `data/test.extxyz` — <1> frames
|
| 32 |
- `index.json` — split counts, checksums, and schema
|
| 33 |
|
| 34 |
### Schema (per-frame)
|
|
|
|
| 44 |
```python
|
| 45 |
from huggingface_hub import snapshot_download
|
| 46 |
local_dir = snapshot_download(
|
| 47 |
+
repo_id="cparidaAI/LMX_dataset",
|
| 48 |
repo_type="dataset",
|
| 49 |
+
local_dir="dataset",
|
| 50 |
local_dir_use_symlinks=False
|
| 51 |
)
|
| 52 |
```
|
|
|
|
| 61 |
```python
|
| 62 |
from huggingface_hub import hf_hub_download
|
| 63 |
path = hf_hub_download(
|
| 64 |
+
repo_id="cparidaAI/LMX_dataset",
|
| 65 |
repo_type="dataset",
|
| 66 |
filename="data/train.extxyz"
|
| 67 |
)
|
|
|
|
| 75 |
- Recommended metrics: energy MAE (meV/atom), force MAE (meV/Å), virial/stress MAE (GPa or eV/ų).
|
| 76 |
|
| 77 |
## Provenance & generation
|
| 78 |
+
- **Code:** VASP/PBE
|
| 79 |
+
- **Settings:** ENCUT, K-mesh, smearing, thresholds, etc.
|
| 80 |
+
- **MD Sampling:** NVT/NPT, T/P ranges, timesteps
|
| 81 |
+
- **Post-processing:** relaxations, filters, deduplication, unit conversions
|
| 82 |
|
| 83 |
## License
|
| 84 |
+
This dataset is released under **will be here**. See `LICENSE`.
|
| 85 |
|
| 86 |
## How to cite
|
| 87 |
Please cite:
|
|
|
|
| 92 |
- v1.0.0 — initial release.
|
| 93 |
|
| 94 |
---
|
| 95 |
+
**Contact:** Chiku Parida, DTU Energy,
|