Aviary
The aim of aviary is to contain multiple models for materials discovery under a common interface, over time we hope to add more models with a particular focus on coordinate-free deep learning models.
Installation
Users can install aviary from source with
pip install aviary-models
or for an editable source install from a local clone:
git clone https://github.com/CompRhys/aviary
pip install -e ./aviary
Example Use from CLI
To test the input files generation and cleaning/canonicalization please run:
python examples/inputs/poscar_to_df.py
This script will load and parse a subset of raw POSCAR files from the TAATA dataset and produce the datasets/examples/examples.csv and datasets/examples/examples.json files used for the next example.
For the coordinate-free roost and wren models where the inputs are easily expressed as strings we use CSV inputs.
For the structure-based cgcnn model we first construct pymatgen structures from the raw POSCAR files then determine their dictionary serializations before saving in a JSON format.
The raw POSCAR files have been selected to ensure that the subset contains all the correct endpoints for the 5 elemental species in the Hf-N-Ti-Zr-Zn chemical system.
To test each of the three models provided please run:
python examples/roost-example.py --train --evaluate --data-path examples/inputs/examples.csv --targets E_f --tasks regression --losses L1 --robust --epoch 10
python examples/wren-example.py --train --evaluate --data-path examples/inputs/examples.csv --targets E_f --tasks regression --losses L1 --robust --epoch 10
python examples/wrenformer-example.py --train --evaluate --data-path examples/inputs/examples.csv --targets E_f --tasks regression --losses L1 --robust --epoch 10
python examples/cgcnn-example.py --train --evaluate --data-path examples/inputs/examples.json --targets E_f --tasks regression --losses L1 --robust --epoch 10
Please note that for speed/demonstration purposes this example runs on only ~68 materials for 10 epochs - running all these examples should take < 30 sec. These examples do not have sufficient data or training to make accurate predictions, however, the same scripts were used for all experiments conducted as part of the development and publication of these models. Consequently understanding these examples will ensure you can deploy the models as intended for your research.
Notebooks
We also provide some notebooks that show more a more pythonic way to interact with the codebase, these examples make use of the TAATA dataset examined in the wren manuscript:
| Roost | ||
| Wren |
Cite This Work
If you use this code please cite the relevant work:
roost - Predicting materials properties without crystal structure: Deep representation learning from stoichiometry. [Paper] [arXiv]
@article{goodall_2020_predicting,
title={Predicting materials properties without crystal structure: Deep representation learning from stoichiometry},
author={Goodall, Rhys EA and Lee, Alpha A},
journal={Nature Communications},
volume={11},
number={1},
pages={1--9},
year={2020},
publisher={Nature Publishing Group}
}
wren - Rapid Discovery of Stable Materials by Coordinate-free Coarse Graining. [Paper] [arXiv]
@article{goodall_2022_rapid,
title={Rapid discovery of stable materials by coordinate-free coarse graining},
author={Goodall, Rhys EA and Parackal, Abhijith S and Faber, Felix A and Armiento, Rickard and Lee, Alpha A},
journal={Science Advances},
volume={8},
number={30},
pages={eabn4117},
year={2022},
publisher={American Association for the Advancement of Science}
}
cgcnn - Crystal Graph Convolutional Neural Networks for an Accurate and Interpretable Prediction of Material Properties. [Paper] [arXiv]
@article{xie_2018_crystal,
title={Crystal graph convolutional neural networks for an accurate and interpretable prediction of material properties},
author={Xie, Tian and Grossman, Jeffrey C},
journal={Physical review letters},
volume={120},
number={14},
pages={145301},
year={2018},
publisher={APS}
}
Disclaimer
This research code is provided as-is. We have checked for potential bugs and believe that the code is being shared in a bug-free state.
Metadata
Release files for aviary-models 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aviary_models-1.2.1.tar.gz | 277.4 kB | Without provenance | Details for aviary_models-1.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aviary_models-1.2.1-py3-none-any.whl | Python 3 | none | any | Details for aviary_models-1.2.1-py3-none-any.whl |
Total release size: 561.9 kB
Release files / aviary_models-1.2.1.tar.gz
| Download URL | aviary_models-1.2.1.tar.gz |
|---|---|
| Size | 277.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a32425a1c71c64d2755ebe6ce72c8ce59b85885e7fc9034f786cdf7a36c4440d
|
|
BLAKE2b-256 checksum How to use checksums |
58291afca908657a88f0816a42af86c375666ac17e683e3ec18720150550847f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.8
|
Release files / aviary_models-1.2.1-py3-none-any.whl
| Download URL | aviary_models-1.2.1-py3-none-any.whl |
|---|---|
| Size | 284.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c744e1916c722da0cf1ef6297d2906a2df9757e0aed080d3ff964cbc4843a44a
|
|
BLAKE2b-256 checksum How to use checksums |
ca8c5cc4703dae673c10e3d95618222487ef2cb02cca1d4b50ef0c3f4d9d1a6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.8
|
Security for aviary-models 1.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.