Some tutorial-style examples for validating machine-learned interatomic potentials, to accompany the article:
How to validate machine-learned interatomic potentials
Joe D. Morrow, John L. A. Gardner, and Volker L. Deringer
-
demo-error-metrics.ipynb: A Python implementation of the RMSE and MAE metrics described in Fig 3. of the article. (authored by John) -
demo-error-scaling.ipynb: A notebook to analyse the error scaling of the RMSE per atom with system size, as in Fig. 4. (authored by John) -
demo-rotation-invariance.ipynb: A demonstration of the dependence of force component MAEs on the orientation of the system. (authored by John) -
demo-similarity.ipynb: A notebook that uses the SOAP kernel to analyse a 10,000-atom compression MD simulation of silicon, as in Fig. 7. (authored by Joe) -
demo-rss.ipynb: A notebook that creates initial 'sensible' random structures (using thebuildcellcode) and generates the plots from Fig. 8. (authored by Joe)
The notebooks above can be run directly, but they may require the installation of some external software if it is not yet available on your system.
To obtain quippy (for SOAP) and other dependencies, run
pip install -r requirements.txt
The code required to run SOAP analysis is free to use for academic purposes (see https://github.com/libAtoms/QUIP for details).
To use demo-rss.ipynb completely, it is necessary to install the buildcell code (see https://www.mtg.msm.cam.ac.uk/Codes/AIRSS for details).
-
The SOAP-similarity-based validation of potentials, on which some of the tutorial examples are based, is described in J. D. Morrow, V. L. Deringer, J. Chem. Phys. 157, 104105 (2022).
-
The SOAP kernel itself is described in A. P. Bartók, R. Kondor, G. Csányi, Phys. Rev. B 87, 184115 (2013).
-
The AIRSS approach, used in
demo-rss.ipynb, is described in C. J. Pickard, R. J. Needs, J. Phys.: Condens. Matter 23 053201 (2011) -
Carbon structural data used for demonstrating error metrics is described in Phys. Rev. B 95, 094203.