Skip to content

Commit

Permalink
Update readme, add bibtex file.
Browse files Browse the repository at this point in the history
  • Loading branch information
henrik-schopmans committed Mar 22, 2023
1 parent f3fbf60 commit 1ab6676
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
8 changes: 8 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@article{schopmans2023pxrd,
title = {Neural networks trained on synthetically generated crystals can extract structural information from ICSD powder X-ray diffractograms},
author = {Henrik Schopmans and Patrick Reiser and Pascal Friederich},
year = {2023},
eprint = {2303.11699},
doi = {10.48550/arXiv.2303.11699},
archiveprefix = {arXiv}
}
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# ML for pXRDs using synthetic crystals
This repository contains the code of the publication "Neural networks trained on
This repository contains the code of the publication ["Neural networks trained on
synthetically generated crystals can extract structural information from ICSD
powder X-ray diffractograms". It can be used to train machine learning models
powder X-ray diffractograms"](https://arxiv.org/abs/2303.11699). It can be used to train machine learning models
(e.g., for the classification of space groups) on powder XRD diffractograms
simulated on-the-fly from synthetically generated random crystal structures.

You can find details about this project in our [`paper`](https://arxiv.org/abs/2303.11699). If you want to cite our work, you can use the provided bibtex file [CITATION.bib](CITATION.bib).

If you have any problems using the provided software, if documentation is
missing, or if you find any bugs, feel free to add a new issue on GitHub.

Expand Down Expand Up @@ -253,8 +255,4 @@ occupancies are used.
- `accuracy gap`: `accuracy random - accuracy match`

Additionally to those metrics, after each epoch, the current learning rate and the current
size of the `ray` queue object (indicating if enough workers are used) are logged.

# Citing
To cite this repository, please refer to our publication:
- TODO: Add reference to arXiv paper
size of the `ray` queue object (indicating if enough workers are used) are logged.

0 comments on commit 1ab6676

Please sign in to comment.