Skip to content

Commit d93bac3

Browse files
authored
release: bump minor version due to cgcnn input changes
1 parent ddb6721 commit d93bac3

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,11 @@ To test the input files generation and cleaning/canonicalization please run:
3535
python examples/inputs/poscar_to_df.py
3636
```
3737

38-
This script will load and parse a subset of raw POSCAR files from the TAATA dataset and produce the `datasets/examples/examples.csv` file used for the next example.
39-
The raw 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.
40-
All the models used share can be run on the input file produced by this example code. To test each of the three models provided please run:
38+
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.
39+
For the coordinate-free `roost` and `wren` models where the inputs are easily expressed as strings we use csv inputs.
40+
For the structure-based `cgcnn` model we first construct `pymatgen` structures from the raw POSCAR files then determine their dictionary serialisations before saving in a json format.
41+
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.
42+
To test each of the three models provided please run:
4143

4244
```sh
4345
python examples/roost-example.py --train --evaluate --data-path examples/inputs/examples.csv --targets E_f --tasks regression --losses L1 --robust --epoch 10
@@ -51,7 +53,8 @@ python examples/wren-example.py --train --evaluate --data-path examples/inputs/e
5153
python examples/cgcnn-example.py --train --evaluate --data-path examples/inputs/examples.json --targets E_f --tasks regression --losses L1 --robust --epoch 10
5254
```
5355

54-
Please note that for speed/demonstration purposes this example runs on only ~68 materials for 10 epochs - running all these examples should take < 30s. These examples do not have sufficient data or training to make accurate predictions, however, the same scripts have been used for all experiments conducted.
56+
Please note that for speed/demonstration purposes this example runs on only ~68 materials for 10 epochs - running all these examples should take < 30s. 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.
57+
Consequently understanding these examples will ensure that you are able to deploy the models as intended for your own research.
5558

5659
## Notebooks
5760

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name="aviary",
5-
version="0.0.4",
5+
version="0.1.0",
66
author="Rhys Goodall",
77
author_email="[email protected]",
88
url="https://github.com/CompRhys/aviary",

0 commit comments

Comments
 (0)