Update README.md
Browse files
README.md
CHANGED
|
@@ -13,17 +13,6 @@ It contains a **~1 GB subset** derived from the full QHMat dataset, intended for
|
|
| 13 |
### Dataset Description
|
| 14 |
|
| 15 |
This dataset is a **small, byte-limited preview** intended for **peer review, sanity checks, and pipeline testing**. It contains **45 crystal/material structures** as serialized graph/tensor records (Hamiltonian and overlap blocks, geometry, and metadata).
|
| 16 |
-
### Direct Use
|
| 17 |
-
|
| 18 |
-
- Training or benchmarking **graph neural networks** and related models on **Hamiltonian / overlap tensor blocks** paired with **crystal structure** fields.
|
| 19 |
-
- **Dataset loader development** and **integration tests** before downloading larger subsets.
|
| 20 |
-
- **Reproducibility checks** during peer review (inspect manifests, decode samples).
|
| 21 |
-
|
| 22 |
-
### Out-of-Scope Use
|
| 23 |
-
|
| 24 |
-
- **Not** a guaranteed statistically representative sample of the full corpus (structure count is small).
|
| 25 |
-
- **Not** for safety-critical or high-stakes decisions without domain validation.
|
| 26 |
-
- **Not** a substitute for the full release when training production-scale models.
|
| 27 |
|
| 28 |
### Files in this release
|
| 29 |
|
|
@@ -50,6 +39,40 @@ After `pickle.loads` on a `.pkl` file, typical `Data` attributes include (names
|
|
| 50 |
|
| 51 |
Use `torch_geometric` introspection or print `data.keys` after loading.
|
| 52 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 53 |
### Splits
|
| 54 |
|
| 55 |
- **Single split:** all samples are shipped under the `train-*` shard prefix (preview bundle). There is **no** separate val/test split in this artifact.
|
|
@@ -76,24 +99,3 @@ This dataset is **not expected** to contain personal data. Identifiers such as `
|
|
| 76 |
- Pin dependency versions in your training repo.
|
| 77 |
- Prefer citing the **paper + dataset version + manifest checksum** once available.
|
| 78 |
|
| 79 |
-
|
| 80 |
-
### Minimal load example (single sample)
|
| 81 |
-
|
| 82 |
-
```python
|
| 83 |
-
import io
|
| 84 |
-
import json
|
| 85 |
-
import pickle
|
| 86 |
-
import tarfile
|
| 87 |
-
|
| 88 |
-
import torch # noqa: F401 — needed for unpickling tensors inside Data
|
| 89 |
-
|
| 90 |
-
tar_path = "train-000000.tar"
|
| 91 |
-
with tarfile.open(tar_path, "r") as tar:
|
| 92 |
-
pkl_info = tar.getmember("00000000.pkl")
|
| 93 |
-
pkl_bytes = tar.extractfile(pkl_info).read()
|
| 94 |
-
meta = json.loads(tar.extractfile(tar.getmember("00000000.json")).read())
|
| 95 |
-
|
| 96 |
-
data = pickle.loads(pkl_bytes)
|
| 97 |
-
print(meta) # {'lmdb_key': ..., 'value_bytes': ...}
|
| 98 |
-
print(data) # torch_geometric.data.Data
|
| 99 |
-
```
|
|
|
|
| 13 |
### Dataset Description
|
| 14 |
|
| 15 |
This dataset is a **small, byte-limited preview** intended for **peer review, sanity checks, and pipeline testing**. It contains **45 crystal/material structures** as serialized graph/tensor records (Hamiltonian and overlap blocks, geometry, and metadata).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
### Files in this release
|
| 18 |
|
|
|
|
| 39 |
|
| 40 |
Use `torch_geometric` introspection or print `data.keys` after loading.
|
| 41 |
|
| 42 |
+
|
| 43 |
+
### Minimal load example (single sample)
|
| 44 |
+
|
| 45 |
+
```python
|
| 46 |
+
import io
|
| 47 |
+
import json
|
| 48 |
+
import pickle
|
| 49 |
+
import tarfile
|
| 50 |
+
|
| 51 |
+
import torch # noqa: F401 — needed for unpickling tensors inside Data
|
| 52 |
+
|
| 53 |
+
tar_path = "train-000000.tar"
|
| 54 |
+
with tarfile.open(tar_path, "r") as tar:
|
| 55 |
+
pkl_info = tar.getmember("00000000.pkl")
|
| 56 |
+
pkl_bytes = tar.extractfile(pkl_info).read()
|
| 57 |
+
meta = json.loads(tar.extractfile(tar.getmember("00000000.json")).read())
|
| 58 |
+
|
| 59 |
+
data = pickle.loads(pkl_bytes)
|
| 60 |
+
print(meta) # {'lmdb_key': ..., 'value_bytes': ...}
|
| 61 |
+
print(data) # torch_geometric.data.Data
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
### Direct Use
|
| 65 |
+
|
| 66 |
+
- Training or benchmarking **graph neural networks** and related models on **Hamiltonian / overlap tensor blocks** paired with **crystal structure** fields.
|
| 67 |
+
- **Dataset loader development** and **integration tests** before downloading larger subsets.
|
| 68 |
+
- **Reproducibility checks** during peer review (inspect manifests, decode samples).
|
| 69 |
+
|
| 70 |
+
### Out-of-Scope Use
|
| 71 |
+
|
| 72 |
+
- **Not** a guaranteed statistically representative sample of the full corpus (structure count is small).
|
| 73 |
+
- **Not** for safety-critical or high-stakes decisions without domain validation.
|
| 74 |
+
- **Not** a substitute for the full release when training production-scale models.
|
| 75 |
+
|
| 76 |
### Splits
|
| 77 |
|
| 78 |
- **Single split:** all samples are shipped under the `train-*` shard prefix (preview bundle). There is **no** separate val/test split in this artifact.
|
|
|
|
| 99 |
- Pin dependency versions in your training repo.
|
| 100 |
- Prefer citing the **paper + dataset version + manifest checksum** once available.
|
| 101 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|