Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

Commit

Permalink
add known limitations section
Browse files Browse the repository at this point in the history
  • Loading branch information
Chi Chen committed May 15, 2019
1 parent 4fbd86e commit fa8f709
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [Implementation details](#implementation-details)
* [Datasets](#datasets)
* [Computing requirements](#computing-requirements)
* [Known limitations](#limitations)
* [References](#references)

<a name="introduction"></a>
Expand Down Expand Up @@ -361,6 +362,16 @@ Prediction: Once trained, prediction using MEGNet models are fairly cheap.
For example, the http://megnet.crystals.ai web app runs on a single hobby dyno
on Heroku and provides the prediction for any crystal within seconds.

<a name="limitations"></a>
# Known limitations

- `isolated atoms` error. This error occurs when using the given cutoff in the model (4A in
2018 models and 5A for 2019 models), the crystal structure contains isolated atoms, i.e.,
no neighboring atoms are within the distance of `cutoff`. Most of the time, we can just
discard the structure, since we found that those structures tend to have a high energy above
hull (less stable). If you find this error becomes an essential issue for a particular problem,
feel free to email us and we will consider release a new model with increased cutoff.

<a name="references"></a>
# References

Expand Down

0 comments on commit fa8f709

Please sign in to comment.