CrystalReasoner commited on
Commit
d21b9ac
·
verified ·
1 Parent(s): 02fd6af

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -8
README.md CHANGED
@@ -21,7 +21,7 @@ This dataset contains the Materials Project-derived reference table used by Crys
21
 
22
  ## Dataset Fields
23
 
24
- The current Parquet file contains 200290 rows. The columns are:
25
 
26
  ```text
27
  material_id
@@ -32,11 +32,16 @@ is_stable
32
  band_gap
33
  is_metal
34
  efermi
35
- bulk_modulus
36
- shear_modulus
37
  homogeneous_poisson
38
  description
39
  formula_pretty
 
 
 
 
 
 
 
40
  thermal_expansion_300k
41
  ```
42
 
@@ -46,9 +51,7 @@ The `structure` column is serialized in the project simple-crystal text format.
46
 
47
  Download the Parquet file and place it at the expected project path:
48
 
49
- ```bash
50
- mkdir -p assets/MP
51
- python - <<'PY_DOWNLOAD'
52
  from huggingface_hub import hf_hub_download
53
 
54
  path = hf_hub_download(
@@ -58,13 +61,12 @@ path = hf_hub_download(
58
  local_dir="assets/MP",
59
  )
60
  print(path)
61
- PY_DOWNLOAD
62
  ```
63
 
64
  Then recreate the shelve database used by the training and evaluation code:
65
 
66
  ```bash
67
- python scripts/parquet_to_shelve.py --source assets/MP/MP_shelve.parquet --output assets/MP/MP_shelve --write --overwrite
68
  ```
69
 
70
  The reconstructed `assets/MP/MP_shelve` database is used by the training datasets, generation code, and ground-truth evaluation metrics.
 
21
 
22
  ## Dataset Fields
23
 
24
+ The current Parquet file contains 200290 rows. These columns are from Materials Project:
25
 
26
  ```text
27
  material_id
 
32
  band_gap
33
  is_metal
34
  efermi
 
 
35
  homogeneous_poisson
36
  description
37
  formula_pretty
38
+ ```
39
+
40
+ and these columns are from our MLIP:
41
+
42
+ ```text
43
+ bulk_modulus
44
+ shear_modulus
45
  thermal_expansion_300k
46
  ```
47
 
 
51
 
52
  Download the Parquet file and place it at the expected project path:
53
 
54
+ ```python
 
 
55
  from huggingface_hub import hf_hub_download
56
 
57
  path = hf_hub_download(
 
61
  local_dir="assets/MP",
62
  )
63
  print(path)
 
64
  ```
65
 
66
  Then recreate the shelve database used by the training and evaluation code:
67
 
68
  ```bash
69
+ python scripts/parquet_to_shelve.py
70
  ```
71
 
72
  The reconstructed `assets/MP/MP_shelve` database is used by the training datasets, generation code, and ground-truth evaluation metrics.