Skip to main content

Graph Neural Network with uncertainty quantification for adsorption energy prediction

Project description

DOI License: MIT Python package PyPI version

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.3.tar.gz (42.3 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.3-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gamenet_uq-0.1.3.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gamenet_uq-0.1.3.tar.gz
Algorithm Hash digest
SHA256 7650a0eecdbadaf44031a4b74ff4d501fb9568568f66551527ef0ae0aebaae85
MD5 0db4967b549e7aa178f203c8f6f60f6a
BLAKE2b-256 a939573cefe3b6dc516719bb0673832b538d76a5328c401f3de63ffcf58ed549

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamenet_uq-0.1.3.tar.gz:

Publisher: publish-to-pypi.yml on LopezGroup-ICIQ/gamenet_uq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: gamenet_uq-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gamenet_uq-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7b5ca2904d89ef82461d7a900b6dd0b748ea2d67e0dd1bdb1590c0876efa070e
MD5 d2140e8e1ea27958fde6b642c51ffbb0
BLAKE2b-256 e5169110115868b09cb295717ddd15a5b8675c811e15ee0077ed7420846705da

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamenet_uq-0.1.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on LopezGroup-ICIQ/gamenet_uq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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