Update README.md
Browse files
README.md
CHANGED
|
@@ -1,67 +1,6 @@
|
|
| 1 |
-
---
|
| 2 |
-
extra_gated_prompt: "You agree to not use the dataset to conduct experiments that cause harm to human subjects."
|
| 3 |
-
extra_gated_fields:
|
| 4 |
-
Company: text
|
| 5 |
-
Name: text
|
| 6 |
-
Position: text
|
| 7 |
-
Purpose_of_data: text
|
| 8 |
-
Contact_Email: text
|
| 9 |
-
Country: country
|
| 10 |
-
Specific_date: date_picker
|
| 11 |
-
|
| 12 |
-
Supervisor_Name (If not applicable, please enter 'None'):
|
| 13 |
-
type: text
|
| 14 |
-
|
| 15 |
-
Supervisor_Email (If not applicable, please enter 'None'):
|
| 16 |
-
type: text
|
| 17 |
-
|
| 18 |
-
I want to use this dataset for:
|
| 19 |
-
type: select
|
| 20 |
-
options:
|
| 21 |
-
- Research
|
| 22 |
-
- Education
|
| 23 |
-
- label: Other
|
| 24 |
-
value: other
|
| 25 |
-
|
| 26 |
-
I agree to use this dataset for non-commercial use ONLY: checkbox
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
extra_gated_heading: "Acknowledge license to accept the repository"
|
| 30 |
-
extra_gated_description: "Our team may take 2–3 days to process your request"
|
| 31 |
-
extra_gated_button_content: "Acknowledge license"
|
| 32 |
-
---
|
| 33 |
-
|
| 34 |
-
**This dataset is part of ongoing work and is not shared at the current stage.**
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
**Please provide your real name and institutional email for verification.**
|
| 38 |
-
If you experience any issues, contact Mr. Cao at: 📧 **bcao686@connect.hkust-gz.edu.cn**
|
| 39 |
-
Fake names or unverifiable information will result in your request being denied.
|
| 40 |
-
|
| 41 |
-
# CPPbenchmark
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
**CPPbenchmark** is a curated benchmark suite for evaluating machine learning models on crystal property prediction (CPP) tasks. It includes eight tasks—seven regression (e.g., formation energy, band gap, elastic moduli) and one classification (metal/non-metal)—using high-quality datasets derived from the Materials Project. All data is provided in ASE `.db` format, enabling easy integration with atomistic ML workflows.
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
## 📝 Access Request Form
|
| 50 |
-
|
| 51 |
-
> Please fill in the form truthfully. We will review your request within **2–3 business days**.
|
| 52 |
-
|
| 53 |
|
| 54 |
|
| 55 |
-
|
| 56 |
-
## 📥 Access & Usage
|
| 57 |
-
|
| 58 |
-
- All required information must be filled out truthfully.
|
| 59 |
-
- Personal verification typically takes **2 working days**.
|
| 60 |
-
- Once approved, you'll be granted download access to the full database.
|
| 61 |
-
|
| 62 |
-
---
|
| 63 |
-
|
| 64 |
-
## 📚 Citation & License
|
| 65 |
|
| 66 |
**Commercial use is strictly prohibited.**
|
| 67 |
All access will be logged.
|
|
@@ -77,21 +16,27 @@ If you use this dataset in your research, please cite **all** the following work
|
|
| 77 |
publisher={Springer}
|
| 78 |
}
|
| 79 |
|
| 80 |
-
@
|
| 81 |
title={SimXRD-4M: Big Simulated X-ray Diffraction Data and Crystal Symmetry Classification Benchmark},
|
| 82 |
-
author={
|
| 83 |
booktitle={The Thirteenth International Conference on Learning Representations}
|
| 84 |
}
|
| 85 |
|
| 86 |
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
publisher = { Hugging Face }
|
| 94 |
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 95 |
```
|
| 96 |
|
| 97 |
|
|
@@ -101,7 +46,7 @@ This benchmark includes **6 primary tasks** for evaluating CPP models in crystal
|
|
| 101 |
|
| 102 |
### **Mission Settings**
|
| 103 |
|
| 104 |
-
####
|
| 105 |
|
| 106 |
1. **T1**: Formation Energy Prediction (`float`) | `eV/atom`
|
| 107 |
2. **T2**: Band Gap Prediction (`float`) | `eV`
|
|
@@ -111,7 +56,7 @@ This benchmark includes **6 primary tasks** for evaluating CPP models in crystal
|
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
-
####
|
| 115 |
|
| 116 |
7. **T6**: Metal/Non-metal Classification (`int`, binary classification)
|
| 117 |
|
|
@@ -121,7 +66,7 @@ This benchmark includes **6 primary tasks** for evaluating CPP models in crystal
|
|
| 121 |
|
| 122 |
The datasets are hosted on Hugging Face and stored in ASE database (`.db`) format. Each database includes crystal structures and corresponding property labels.
|
| 123 |
|
| 124 |
-
###
|
| 125 |
|
| 126 |
* **Train:** `MP_100_bgfe_train.db` (86,071 crystals)
|
| 127 |
* **Val:** `MP_100_bgfe_val.db` (12,295 crystals)
|
|
@@ -130,7 +75,7 @@ The datasets are hosted on Hugging Face and stored in ASE database (`.db`) forma
|
|
| 130 |
|
| 131 |
* Keys: `formation_energy`, `band_gap`
|
| 132 |
|
| 133 |
-
###
|
| 134 |
|
| 135 |
* **Train:** `MP_modulus_train.db` (6,631 crystals)
|
| 136 |
* **Val:** `MP_modulus_val.db` (947 crystals)
|
|
@@ -139,7 +84,7 @@ The datasets are hosted on Hugging Face and stored in ASE database (`.db`) forma
|
|
| 139 |
|
| 140 |
* Keys: `bulk_modulus`, `shear_modulus`, `youngs_modulus`, `poissons_ratio`,
|
| 141 |
|
| 142 |
-
###
|
| 143 |
|
| 144 |
* **Train:** `MP_100_metal_train.db` (86,071 crystals)
|
| 145 |
* **Val:** `MP_100_metal_val.db` (12,295 crystals)
|
|
@@ -158,7 +103,7 @@ In preparing the dataset for model training, we applied a log10 transformation t
|
|
| 158 |
|
| 159 |
---
|
| 160 |
|
| 161 |
-
##
|
| 162 |
|
| 163 |
You can read data using the `ase.db` module as follows:
|
| 164 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
|
| 2 |
|
| 3 |
+
## Citation & License
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
**Commercial use is strictly prohibited.**
|
| 6 |
All access will be logged.
|
|
|
|
| 16 |
publisher={Springer}
|
| 17 |
}
|
| 18 |
|
| 19 |
+
@article{binsimxrd,
|
| 20 |
title={SimXRD-4M: Big Simulated X-ray Diffraction Data and Crystal Symmetry Classification Benchmark},
|
| 21 |
+
author={Cao, Bin and Liu, Yang and Zheng, Zinan and Tan, Ruifeng and Li, Jia and Zhang, Tong-yi},
|
| 22 |
booktitle={The Thirteenth International Conference on Learning Representations}
|
| 23 |
}
|
| 24 |
|
| 25 |
|
| 26 |
+
|
| 27 |
+
@article{cao2025beyond,
|
| 28 |
+
title={Beyond Structure: Invariant Crystal Property Prediction with Pseudo-Particle Ray Diffraction},
|
| 29 |
+
author={Cao, Bin and Liu, Yang and Zhang, Longhan and Wu, Yifan and Li, Zhixun and Luo, Yuyu and Cheng, Hong and Ren, Yang and Zhang, Tong-Yi},
|
| 30 |
+
booktitle={The Thirteenth International Conference on Learning Representations},
|
| 31 |
+
year={2026}
|
|
|
|
| 32 |
}
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
|
| 40 |
```
|
| 41 |
|
| 42 |
|
|
|
|
| 46 |
|
| 47 |
### **Mission Settings**
|
| 48 |
|
| 49 |
+
#### Regression Tasks
|
| 50 |
|
| 51 |
1. **T1**: Formation Energy Prediction (`float`) | `eV/atom`
|
| 52 |
2. **T2**: Band Gap Prediction (`float`) | `eV`
|
|
|
|
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
+
#### Classification Task
|
| 60 |
|
| 61 |
7. **T6**: Metal/Non-metal Classification (`int`, binary classification)
|
| 62 |
|
|
|
|
| 66 |
|
| 67 |
The datasets are hosted on Hugging Face and stored in ASE database (`.db`) format. Each database includes crystal structures and corresponding property labels.
|
| 68 |
|
| 69 |
+
### `fe_bandg/`
|
| 70 |
|
| 71 |
* **Train:** `MP_100_bgfe_train.db` (86,071 crystals)
|
| 72 |
* **Val:** `MP_100_bgfe_val.db` (12,295 crystals)
|
|
|
|
| 75 |
|
| 76 |
* Keys: `formation_energy`, `band_gap`
|
| 77 |
|
| 78 |
+
### `modulus/`
|
| 79 |
|
| 80 |
* **Train:** `MP_modulus_train.db` (6,631 crystals)
|
| 81 |
* **Val:** `MP_modulus_val.db` (947 crystals)
|
|
|
|
| 84 |
|
| 85 |
* Keys: `bulk_modulus`, `shear_modulus`, `youngs_modulus`, `poissons_ratio`,
|
| 86 |
|
| 87 |
+
### `metal_nometal/`
|
| 88 |
|
| 89 |
* **Train:** `MP_100_metal_train.db` (86,071 crystals)
|
| 90 |
* **Val:** `MP_100_metal_val.db` (12,295 crystals)
|
|
|
|
| 103 |
|
| 104 |
---
|
| 105 |
|
| 106 |
+
## Example: Reading Data from an ASE Database
|
| 107 |
|
| 108 |
You can read data using the `ase.db` module as follows:
|
| 109 |
|