maml is a machine learning library for materials science.
Project description
maml (MAterials Machine Learning) is a Python package that aims to provide useful high-level interfaces that make ML for materials science as easy as possible.
The goal of maml is not to duplicate functionality already available in other packages. maml relies on well-established packages such as scikit-learn and tensorflow for implementations of ML algorithms, as well as other materials science packages such as pymatgen and matminer for crystal/molecule manipulation and feature generation.
Official documentation at http://maml.ai/
Features
Convert materials (crystals and molecules) into features. In addition to common compositional, site and structural features, we provide the following fine-grain local environment features.
Bispectrum coefficients
Behler Parrinello symmetry functions
Smooth Overlap of Atom Position (SOAP)
Graph network features (composition, site and structure)
Use ML to learn relationship between features and targets. Currently, the maml supports sklearn and keras models.
Applications:
pes for modelling the potential energy surface, constructing surrogate models for property prediction.
Neural Network Potential (NNP)
Gaussian approximation potential (GAP) with SOAP features
Spectral neighbor analysis potential (SNAP)
Moment Tensor Potential (MTP)
rfxas for random forest models in predicting atomic local environments from X-ray absorption spectroscopy.
Installation
Pip install via PyPI:
pip install maml
To run the potential energy surface (pes), lammps installation is required you can install from source or from conda:
conda install -c conda-forge/label/cf202003 lammps
The SNAP potential comes with this lammps installation. The GAP package for GAP and MLIP package for MTP are needed to run the corresponding potentials. For fitting NNP potential, the n2p2 package is needed.
Install all the libraries from requirement.txt file:
pip install -r requirements.txt
For all the requirements above:
pip install -r requirements-ci.txt pip install -r requirements-optional.txt pip install -r requirements-dl.txt pip install -r requirements.txt
Citing
@misc{maml, author = {Chen, Chi and Zuo, Yunxing and Ye, Weike and Ong, Shyue Ping}, title = {{Maml - materials machine learning package}}, year = {2020}, publisher = {GitHub}, journal = {GitHub repository}, howpublished = {https://github.com/materialsvirtuallab/maml}, }
For the ML-IAP package (maml.pes), please cite:
Zuo, Y.; Chen, C.; Li, X.; Deng, Z.; Chen, Y.; Behler, J.; Csányi, G.; Shapeev, A. V.; Thompson, A. P.; Wood, M. A.; Ong, S. P. Performance and Cost Assessment of Machine Learning Interatomic Potentials. J. Phys. Chem. A 2020, 124 (4), 731–745. https://doi.org/10.1021/acs.jpca.9b08723.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file maml-2021.12.13.tar.gz
.
File metadata
- Download URL: maml-2021.12.13.tar.gz
- Upload date:
- Size: 3.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f54a7f296554862660fb8a5a8cef55047d6deb2d6552a5ea69cd91198fdb22b3 |
|
MD5 | 204a9a654c488921a14f13636d88c961 |
|
BLAKE2b-256 | da46b1eee1d69d4b28966cde2e607cfaadca2efe2957da09a329726302b247a7 |
File details
Details for the file maml-2021.12.13-py3-none-any.whl
.
File metadata
- Download URL: maml-2021.12.13-py3-none-any.whl
- Upload date:
- Size: 4.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 502e92ab14f7bffb21e37b8e76477633bf5bd20a46417ce7d95356240a28b7fa |
|
MD5 | cf5dcef2dfe39520523654058e68fa5e |
|
BLAKE2b-256 | 23b6b043b33a546df512bcb527be7e8a319647d2ad099e50da5c5b55358febeb |