yaotianvector commited on
Commit
cbe7d62
·
verified ·
1 Parent(s): 1671d29

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +93 -86
README.md CHANGED
@@ -1,86 +1,93 @@
1
- # AutoMat Benchmark: STEM Image to Crystal Structure
2
-
3
- The **AutoMat Benchmark** is a multimodal dataset designed to evaluate deep‑learning systems for iDPC-STEM‑based crystal‑structure reconstruction and property prediction.
4
-
5
- ---
6
-
7
- ## 📁 Dataset Structure
8
-
9
- The dataset is organized into three tiers of increasing difficulty:
10
-
11
- ```text
12
- benchmark/
13
- ├── tier1/
14
- │ ├── img/ # STEM images (e.g., PNG, TIFF)
15
- │ ├── label/ # Atomic position labels (e.g., TXT, JSON)
16
- │ └── cif_file/ # Reconstructed or ground‑truth CIF files
17
- ├── tier2/
18
- │ └── ... # Same sub‑folders as tier1
19
- ├── tier3/
20
- │ └── ...
21
- ── property.csv # Material properties for all samples
22
- ````
23
-
24
- ---
25
-
26
- ## 🔬 Tier Descriptions
27
-
28
- | Tier | Characteristics |
29
- |--------|----------------------------------------------------------------|
30
- | Tier 1 | Simulated low-noise STEM images, light elements, low complexity |
31
- | Tier 2 | Moderate noise or multiple elements, more realistic patterns |
32
- | Tier 3 | Low dose, multi-elements, complex symmetry |
33
-
34
- Each sample in the dataset includes:
35
- - A STEM image (`img/`)
36
- - Labeled atomic coordinates (`label/`)
37
- - A reconstructed or reference CIF file (`cif_file/`)
38
- - Associated material properties in `property.csv`
39
-
40
- ---
41
-
42
- ## 📊 Tasks Supported
43
-
44
- - STEM-to-structure inference
45
- - CIF generation and comparison
46
- - Atomic position prediction
47
- - Property prediction (formation energy, energy_per_atom, bandgap, etc.)
48
-
49
- ---
50
-
51
- ## 🔗 Files Description
52
-
53
- | File / Folder | Description |
54
- |--------------------|------------------------------------------------------------|
55
- | `img/` | STEM input images (grayscale microscopy) |
56
- | `label/` | Atomic position data (format: .txt / .json per sample) |
57
- | `cif_file/` | .cif crystal structure files for each sample |
58
- | `property.csv` | Global material properties table with `material_id` match |
59
-
60
- ---
61
-
62
- ## 📄 License
63
-
64
- This dataset is released under the **MIT License**. You are free to use, modify, and distribute with attribution.
65
-
66
- ---
67
-
68
- ## ✉️ Citation
69
-
70
- If you use this benchmark, please cite:
71
-
72
- ```bibtex
73
- @dataset{yang2025automat,
74
- author = {Yaotian Yang et al.},
75
- title = {AutoMat Benchmark for STEM Image-Based Crystal Structure Reconstruction},
76
- year = {2025},
77
- url = {https://huggingface.co/datasets/yaotianvector/STEM2Mat}
78
- }
79
- ```
80
-
81
- ---
82
-
83
- ## 🙋 Contact
84
-
85
- For questions or collaborations, please contact: `yangyt22@gmail.com`
86
-
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ tags:
4
+ - chemistry
5
+ pretty_name: STEM2Mat
6
+ size_categories:
7
+ - 1K<n<10K
8
+ ---
9
+ # AutoMat Benchmark: STEM Image to Crystal Structure
10
+
11
+ The **AutoMat Benchmark** is a multimodal dataset designed to evaluate deep‑learning systems for iDPC-STEM‑based crystal‑structure reconstruction and property prediction.
12
+
13
+ ---
14
+
15
+ ## 📁 Dataset Structure
16
+
17
+ The dataset is organized into three tiers of increasing difficulty:
18
+
19
+ ```text
20
+ benchmark/
21
+ ── tier1/
22
+ │ ├── img/ # STEM images (e.g., PNG, TIFF)
23
+ │ ├── label/ # Atomic position labels (e.g., TXT, JSON)
24
+ │ └── cif_file/ # Reconstructed or ground‑truth CIF files
25
+ ├── tier2/
26
+ │ └── ... # Same sub‑folders as tier1
27
+ ├── tier3/
28
+ └── ...
29
+ └── property.csv # Material properties for all samples
30
+ ````
31
+
32
+ ---
33
+
34
+ ## 🔬 Tier Descriptions
35
+
36
+ | Tier | Characteristics |
37
+ |--------|----------------------------------------------------------------|
38
+ | Tier 1 | Simulated low-noise STEM images, light elements, low complexity |
39
+ | Tier 2 | Moderate noise or multiple elements, more realistic patterns |
40
+ | Tier 3 | Low dose, multi-elements, complex symmetry |
41
+
42
+ Each sample in the dataset includes:
43
+ - A STEM image (`img/`)
44
+ - Labeled atomic coordinates (`label/`)
45
+ - A reconstructed or reference CIF file (`cif_file/`)
46
+ - Associated material properties in `property.csv`
47
+
48
+ ---
49
+
50
+ ## 📊 Tasks Supported
51
+
52
+ - STEM-to-structure inference
53
+ - CIF generation and comparison
54
+ - Atomic position prediction
55
+ - Property prediction (formation energy, energy_per_atom, bandgap, etc.)
56
+
57
+ ---
58
+
59
+ ## 🔗 Files Description
60
+
61
+ | File / Folder | Description |
62
+ |--------------------|------------------------------------------------------------|
63
+ | `img/` | STEM input images (grayscale microscopy) |
64
+ | `label/` | Atomic position data (format: .txt / .json per sample) |
65
+ | `cif_file/` | .cif crystal structure files for each sample |
66
+ | `property.csv` | Global material properties table with `material_id` match |
67
+
68
+ ---
69
+
70
+ ## 📄 License
71
+
72
+ This dataset is released under the **MIT License**. You are free to use, modify, and distribute with attribution.
73
+
74
+ ---
75
+
76
+ ## ✉️ Citation
77
+
78
+ If you use this benchmark, please cite:
79
+
80
+ ```bibtex
81
+ @dataset{yang2025automat,
82
+ author = {Yaotian Yang et al.},
83
+ title = {AutoMat Benchmark for STEM Image-Based Crystal Structure Reconstruction},
84
+ year = {2025},
85
+ url = {https://huggingface.co/datasets/yaotianvector/STEM2Mat}
86
+ }
87
+ ```
88
+
89
+ ---
90
+
91
+ ## 🙋 Contact
92
+
93
+ For questions or collaborations, please contact: `yangyt22@gmail.com`