Skip to main content

Graph Neural Network with uncertainty quantification for adsorption energy prediction

Project description

DOI License: MIT Python package

GAME-Net-UQ

This repository contains the Python code used to train and evaluate GAME-Net-UQ, a graph neural network with uncertainty quantification (UQ) for predicting the DFT energy of relaxed species and transition states adsorbed on metal surfaces.

Install

pip install gamenet-uq

The main dependencies of the repo can be found in pyproject.toml

DFT dataset

The DFT dataset fg.db (217 MB) used to train the GNN will be soon uploaded to Zenodo as ASE database including the DFT VASP relaxed geometries, simulation settings, and other metadata.

Graph dataset generation from ASE databases

The graph dataset (92 MB) can be automatically generated from the ASE database with the script gen_dataset.py. The same script can be used to generate your custom dataset from external ASE databases.

Model training and finetuning

To train the model, run the script train_mve.py. The input template file provides an explanation for each entry required in the training configuration file.

python train_mve.py -i input.toml -o output_dirname

Pretrained model

The final pretrained model can be employed with CARE (link).

License

The code is released under the MIT license.

Reference

  • A Foundational Model for Reaction Networks on Metal Surfaces
    Authors: S. Morandi, O. Loveday, T. Renningholtz, S. Pablo-García, R. A. Vargas Hernáńdez, R. R. Seemakurthi, P. Sanz Berman, R. García-Muelas, A. Aspuru-Guzik, and N. López
    DOI: 10.26434/chemrxiv-2024-bfv3d

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gamenet_uq-0.1.1.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gamenet_uq-0.1.1-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file gamenet_uq-0.1.1.tar.gz.

File metadata

  • Download URL: gamenet_uq-0.1.1.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for gamenet_uq-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5cd864d77c6218879b5f6844b634c54ba02fc17628aab80276edec59fb12fc32
MD5 0d1d73efa1705b9377eecc2ce37475d0
BLAKE2b-256 5ca54d24d2f1c948090b64d95f5f24f9a8564a970f48aa1629aa9004c93c48d1

See more details on using hashes here.

File details

Details for the file gamenet_uq-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gamenet_uq-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for gamenet_uq-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 25ea51d5e3d67f617a20960f1321bc1731b81ac9b4a54c5e9d56290df61275c3
MD5 7c619c643e61a9ba1362a72affe10dd2
BLAKE2b-256 3aa323f0caa4a6f8a147e9ce77c0516b0958aced392ee48c24f1d72d788334c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page