markus-goetz commited on
Commit
09ad38c
Β·
verified Β·
1 Parent(s): a657d9c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -0
README.md CHANGED
@@ -18,11 +18,70 @@ size_categories:
18
  [![License](https://img.shields.io/badge/Licenses-CC_BY_4.0-green)](./LICENSE)
19
  [![Contact](https://img.shields.io/badge/Contact-SEAOPT-blue)](mailto:SE-AOPT-office@helmholtz-berlin.de)
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
  ## Acknowledgements
23
 
24
  This work is supported by the Helmholtz Association Initiative and Networking Fund through the Helmholtz AI platform, and the HAICORE@KIT grant.
25
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
  ----
27
 
28
  <div style="float: left; position: relative; left: 50%; transform: translateX(-50%);">
 
18
  [![License](https://img.shields.io/badge/Licenses-CC_BY_4.0-green)](./LICENSE)
19
  [![Contact](https://img.shields.io/badge/Contact-SEAOPT-blue)](mailto:SE-AOPT-office@helmholtz-berlin.de)
20
 
21
+ ## Details
22
+
23
+ The original dataset can be found in the [OptoGPT publication πŸ“](https://arxiv.org/abs/2304.10294) and here on [HuggingFace](https://huggingface.co/datasets/mataigao/optogpt_data).
24
+
25
+ **Key Enhancements**
26
+
27
+ - Inclusion of an **absorption** feature in the model βž•πŸ“ˆ
28
+ - Increased the maximum **wave length** to 2,000nm πŸ’‘
29
+ - Additional **materials**, e.g. EVA πŸ‘
30
+
31
+ ## Structure
32
+
33
+ ```
34
+ β”œβ”€β”€ materials/
35
+ β”‚ β”œβ”€β”€ Ag.csv
36
+ β”‚ β”œβ”€β”€ Al.csv
37
+ β”‚ β”œβ”€β”€ ...
38
+ β”‚ └── ZnSe.csv
39
+ β”œβ”€β”€ train/
40
+ β”‚ β”œβ”€β”€ train-00.safetensors
41
+ β”‚ β”œβ”€β”€ train-01.safetensors
42
+ β”‚ β”œβ”€β”€ ...
43
+ β”‚ └── train-09.safetensors
44
+ β”œβ”€β”€ test/
45
+ β”‚ └── test.safetensors
46
+ └── tokens.json
47
+ ```
48
+
49
+ Each `*.safetensors` file contains 1 million thin film structures (indexed by `tokens.json`) as well as their simulated absorption, reflection and transmission (RAT) spectrum.
50
+
51
+ The spectrum tensors have the shape *(n_samples, 3 [RAT], 171 [bins],)* and are stores in `bfloat16`. The thin film layers have the shape *(n_samples, 20 [max_depth],)* and are stored as long.
52
+
53
+ The thin film layer sequence is ordered from top to bottom, i.e., the lowest index is the top of the thin film layers (touches the air), and the highest index is the bottom layer (touching the back substrate).
54
+
55
+
56
+ ## Details
57
+
58
+ - All spectra have been simulated with [tmm_fast](https://github.com/MLResearchAtOSRAM/tmm_fast)
59
+ - The *n* (refractive index) and *k* (extinction coefficients) of all materials can be found in CSV files in the `/materials` folder
60
+ - The training and test data are pre-split and can be found in the `/train` and `/test` folder respectively
61
+ - A full list of the vocabular, i.e., all possible tokens, can be found in the `tokens.json`, with the the format of `<material>_<thickness_in_nm>`
62
+ - There are additional tokens for end of sequences (EOS), padding (PAD) and masking (MASK)
63
 
64
  ## Acknowledgements
65
 
66
  This work is supported by the Helmholtz Association Initiative and Networking Fund through the Helmholtz AI platform, and the HAICORE@KIT grant.
67
 
68
+ ## Citations
69
+
70
+ If you find our work helpful, please feel free to cite as following:
71
+
72
+ ```
73
+ @article{ma2024optogpt,
74
+ title={OptoGPT: a foundation model for inverse design in optical multilayer thin film structures},
75
+ author={Ma, Taigao and Wang, Haozhu and Guo, L Jay},
76
+ journal={Opto-Electronic Advances},
77
+ volume={7},
78
+ number={7},
79
+ year={2024},
80
+ publisher={Opto-Electronic Advance},
81
+ doi={10.29026/oea.2024.240062}
82
+ }
83
+ ```
84
+
85
  ----
86
 
87
  <div style="float: left; position: relative; left: 50%; transform: translateX(-50%);">