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.2.tar.gz (42.1 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.2-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gamenet_uq-0.1.2.tar.gz
  • Upload date:
  • Size: 42.1 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.2.tar.gz
Algorithm Hash digest
SHA256 72ae2991a133b37e01b864863c1c26b84430acf2d1841c0a841f115d8490b070
MD5 d09578ca1be83856da413ad76667dab3
BLAKE2b-256 382a58780aece43dc2d1867ed0580e41a7a211e8d3612443015e1210bcaa1b90

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamenet_uq-0.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: gamenet_uq-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 44.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3502d3f91c5df05c8d9b8305856163f899f6c197b70add4469b84d25c60d62f9
MD5 7cb985c0f32b34f066f2714c038eb31a
BLAKE2b-256 959b68d6cc2d8ca47dbfe085b1dad1591bdda92bd281502c3e38928a94736ca4

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamenet_uq-0.1.2-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