MODNet, the Material Optimal Descriptor Network for materials properties prediction.
Project description
MODNet: Material Optimal Descriptor Network
Introduction
This repository contains the Python (3.8) package implementing the Material Optimal Descriptor Network (MODNet). It is a supervised machine learning framework for learning material properties from either the composition or crystal structure. The framework is well suited for limited datasets and can be used for learning multiple properties together by using joint learning.
MODNet appears on the MatBench leaderboard. As of 11/11/2021, MODNet provides the best performance of all submitted models on 7 out of 13 tasks.
This repository also contains two pretrained models that can be used for predicting the refractive index and vibrational thermodynamics from any crystal structure.
See the MODNet papers and repositories below for more details:
- De Breuck et al., "Materials property prediction for limited datasets enabled by feature selection and joint learning with MODNet." npj Comput Mater 7, 83 (2021). 10.1038/s41524-021-00552-2 (preprint: arXiv:2004.14766).
- De Breuck et al., "Robust model benchmarking and bias-imbalance in data-driven materials science: a case study on MODNet." J. Phys.: Condens. Matter 33 404002, (2021), 10.1088/1361-648X/ac1280 (preprint: arXiv:2102.02263).
- MatBench benchmarking data repository: ml-evs/modnet-matbench.
How to install
First, create a virtual environment (e.g., named modnet) with Python 3.8:
conda create -n modnet python=3.8
activate the environment:
conda activate modnet
Then, install pymatgen v2020.8.13 with conda, which will bundle several pre-built dependencies (e.g., numpy, scipy):
conda install -c conda-forge pymatgen=2020.8.13
Finally, install MODNet from PyPI with pip:
pip install modnet
Documentation
The documentation is available at ReadTheDocs.
Author
This software was written by Pierre-Paul De Breuck and Matthew Evans with contributions from David Waroquiers and Gregoire Heymans. For an up-to-date list, see the Contributors on GitHub.
License
MODNet is released under the MIT License.
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
File details
Details for the file modnet-0.1.12.dev0.tar.gz.
File metadata
- Download URL: modnet-0.1.12.dev0.tar.gz
- Upload date:
- Size: 10.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.26.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f4991f44200398d214b24a474dfb312a6cd3bf59d6612f5ddc1d10a2cd88ba58 |
|
| MD5 | 5a62118ac4a7631e23e9fceb61c2bf69 |
|
| BLAKE2b-256 | 81975063b4b05b015dcce259c494fe4457990ab29b7f5f05000c88b9482e77f4 |
