DeePMD-kit plugin for graph neural network models.

Navigation

Verified details

These details have been verified by PyPI
Owner

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (GNU LESSER GENERAL PUBLIC LICENSE)
  • Author: Jinzhe Zeng
  • Requires: Python >=3.9
  • Provides-Extra: test , docs
Classifiers
Report project as malware

Project description

DeePMD-kit plugin for various graph neural network models

DOI:10.1021/acs.jcim.4c02441 Citations conda install PyPI - Version

deepmd-gnn is a DeePMD-kit plugin for various graph neural network (GNN) models, which connects DeePMD-kit and atomistic GNN packages by enabling GNN models in DeePMD-kit.

Supported packages and models include:

After installing the plugin, you can train the GNN models using DeePMD-kit, run active learning cycles for the GNN models using DP-GEN, perform simulations with the MACE model using molecular dynamic packages supported by DeePMD-kit, such as LAMMPS and AMBER. You can follow DeePMD-kit documentation to train the GNN models using its PyTorch backend, after using the specific model parameters.

Credits

If you use this software, please cite the following paper:

  • Jinzhe Zeng, Timothy J. Giese, Duo Zhang, Han Wang, Darrin M. York, DeePMD-GNN: A DeePMD-kit Plugin for External Graph Neural Network Potentials, J. Chem. Inf. Model., 2025, 65, 7, 3154-3160, DOI: 10.1021/acs.jcim.4c02441. Citations

Installation

Install via conda

If you are in a conda environment where DeePMD-kit is already installed from the conda-forge channel, you can use conda to install the DeePMD-GNN plugin:

conda install deepmd-gnn -c conda-forge

Build from source

First, clone this repository:

git clone https://gitlab.com/RutgersLBSR/deepmd-gnn
cd deepmd-gnn

Python interface plugin

Python 3.9 or above is required. A C++ compiler that supports C++ 14 (for PyTorch 2.0) or C++ 17 (for PyTorch 2.1 or above) is required.

Assume you have installed DeePMD-kit (v3.0.0b2 or above) and PyTorch in an environment, then execute

# expose PyTorch CMake modules
export CMAKE_PREFIX_PATH=$(python -c "import torch;print(torch.utils.cmake_prefix_path)")

pip install .

C++ interface plugin

DeePMD-kit version should be v3.0.0b4 or later.

Follow DeePMD-kit documentation to install DeePMD-kit C++ interface with PyTorch backend support and other related MD packages. After that, you can build the plugin

# Assume libtorch has been contained in CMAKE_PREFIX_PATH
mkdir -p build
cd build
cmake .. -D CMAKE_INSTALL_PREFIX=/prefix/to/install
cmake --build . -j8
cmake --install .

libdeepmd_gnn.so will be installed into the directory you assign. When using any DeePMD-kit C++ interface, set the following environment variable in advance:

export DP_PLUGIN_PATH=/prefix/to/install/lib/libdeepmd_gnn.so

Usage

Follow Parameters section to prepare a DeePMD-kit input file.

dp --pt train input.json
dp --pt freeze

A frozen model file named frozen_model.pth will be generated. You can use it in the MD packages or other interfaces. For details, follow DeePMD-kit documentation.

Running LAMMPS + MACE with period boundary conditions

GNN models use message passing neural networks, so the neighbor list built with traditional cutoff radius will not work, since the ghost atoms also need to build neighbor list. By default, the model requests the neighbor list with a cutoff radius of $r_c \times N_{L}$, where $r_c$ is set by r_max and $N_L$ is set by num_interactions (MACE) / num_layers (NequIP), and rebuilds the neighbor list for ghost atoms. However, this approach is very inefficient.

The alternative approach for the MACE model (note: NequIP doesn't support such approach) is to use the mapping passed from LAMMPS, which does not support MPI. One needs to set DP_GNN_USE_MAPPING when freezing the models,

DP_GNN_USE_MAPPING=1 dp --pt freeze

and request the mapping when using LAMMPS (also requires DeePMD-kit v3.0.0rc0 or above). By using the mapping, the ghost atoms will be mapped to the real atoms, so the regular neighbor list with a cutoff radius of $r_c$ can be used.

atom_modify map array

In the future, we will explore utilizing the MPI to communicate the neighbor list, while this approach requires a deep hack for external packages.

Parameters

MACE

To use the MACE model, set "type": "mace" in the model section of the training script. Below is default values for the MACE model, most of which follows default values in the MACE package:

"model": {
  "type": "mace",
  "type_map": [
    "O",
    "H"
  ],
  "r_max": 5.0,
  "sel": "auto",
  "num_radial_basis": 8,
  "num_cutoff_basis": 5,
  "max_ell": 3,
  "interaction": "RealAgnosticResidualInteractionBlock",
  "num_interactions": 2,
  "hidden_irreps": "128x0e + 128x1o",
  "pair_repulsion": false,
  "distance_transform": "None",
  "correlation": 3,
  "gate": "silu",
  "MLP_irreps": "16x0e",
  "radial_type": "bessel",
  "radial_MLP": [64, 64, 64],
  "std": 1.0,
  "precision": "float32"
}

NequIP

"model": {
  "type": "nequip",
  "type_map": [
    "O",
    "H"
  ],
  "r_max": 5.0,
  "sel": "auto",
  "num_layers": 4,
  "l_max": 2,
  "num_features": 32,
  "nonlinearity_type": "gate",
  "parity": true,
  "num_basis": 8,
  "BesselBasis_trainable": true,
  "PolynomialCutoff_p": 6,
  "invariant_layers": 2,
  "invariant_neurons": 64,
  "use_sc": true,
  "irreps_edge_sh": "0e + 1e",
  "feature_irreps_hidden": "32x0o + 32x0e + 32x1o + 32x1e",
  "chemical_embedding_irreps_out": "32x0e",
  "conv_to_output_hidden_irreps_out": "16x0e",
  "precision": "float32"
}

DPRc support

In deepmd-gnn, the GNN model can be used in a DPRc way. Type maps that starts with m (such as mH) or OW or HW will be recognized as MM types. Two MM atoms will not build edges with each other. Such GNN+DPRc model can be directly used in AmberTools24.

Examples

Project details

Verified details

These details have been verified by PyPI
Owner

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (GNU LESSER GENERAL PUBLIC LICENSE)
  • Author: Jinzhe Zeng
  • Requires: Python >=3.9
  • Provides-Extra: test , docs
Classifiers

Release history Release notifications | RSS feed

This version

0.1.2

0.1.1

0.1.0

Download files

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

Source Distribution

deepmd_gnn-0.1.2.tar.gz (2.1 MB view details)

Uploaded Source

Built Distributions

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

deepmd_gnn-0.1.2-py2.py3-none-win_amd64.whl (73.3 kB view details)

Uploaded Python 2Python 3Windows x86-64

deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (47.9 kB view details)

Uploaded Python 2Python 3manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl (48.0 kB view details)

Uploaded Python 2Python 3manylinux: glibc 2.24+ ARM64manylinux: glibc 2.28+ ARM64

deepmd_gnn-0.1.2-py2.py3-none-macosx_11_0_arm64.whl (47.3 kB view details)

Uploaded Python 2Python 3macOS 11.0+ ARM64

deepmd_gnn-0.1.2-py2.py3-none-macosx_10_13_x86_64.whl (47.8 kB view details)

Uploaded Python 2Python 3macOS 10.13+ x86-64

File details

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

File metadata

  • Download URL: deepmd_gnn-0.1.2.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for deepmd_gnn-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1627850581976914549eab73400839a6a293bc2003e24aadf7810ee7e88b26b1
MD5 3cc9f76358835afb7c7555e3daa844f7
BLAKE2b-256 059a092cf7fd27849bcf49baa025459a65ac0e88647659c3c6d7c8ce606e356c

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2.tar.gz:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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

File details

Details for the file deepmd_gnn-0.1.2-py2.py3-none-win_amd64.whl.

File metadata

  • Download URL: deepmd_gnn-0.1.2-py2.py3-none-win_amd64.whl
  • Upload date:
  • Size: 73.3 kB
  • Tags: Python 2, Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for deepmd_gnn-0.1.2-py2.py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7187f353d52bc06d467b3cfbd6a2d3e41156174865ea146aacc99f175a2f7db6
MD5 873ac5661a6708d760a17209a18513af
BLAKE2b-256 74a7cc79a2aaa944ce23970fdc7a106f7453d37d6fcb3406333eedac11cf1a93

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2-py2.py3-none-win_amd64.whl:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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

File details

Details for the file deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0ea9a3434f4119046ac593925815bd31fd6f9ed22e6a173258787181d440e755
MD5 29dd4fc49296d466895dff6c5666ed92
BLAKE2b-256 a43d0d03315a9f7f59b313e00aea9afb0643ac8b6d4a7481a7faa1df91775053

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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

File details

Details for the file deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 667cc55781ffbcd26b0554473a5f9468cb6af10bfc0de9cc18fa068e299cd95b
MD5 6b9be97ad2a3616a62a097f4bd3d6402
BLAKE2b-256 f372aebc5b276794c2af2f55ae5844d3b05aba225f92ba317017470781a35315

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2-py2.py3-none-manylinux_2_24_aarch64.manylinux_2_28_aarch64.whl:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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

File details

Details for the file deepmd_gnn-0.1.2-py2.py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for deepmd_gnn-0.1.2-py2.py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 944e094710d43a0551ce5f297c854329d8057cecb5f9862679457a7ce0adf33a
MD5 974aeadacddca33403c02bd9f30b7fa2
BLAKE2b-256 abf5ca069f91795a7a6752e3ef920fe7f476f2eec5b155df39eba4c6c39fc1b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2-py2.py3-none-macosx_11_0_arm64.whl:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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

File details

Details for the file deepmd_gnn-0.1.2-py2.py3-none-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for deepmd_gnn-0.1.2-py2.py3-none-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 0f37793a8203837b9b3cd637cf47551e05b260bc7b9d9b81ad9786793ac37ec9
MD5 0d17010d8c9dc2ab24ed89ab3272433f
BLAKE2b-256 b8705e2d0c0414989ac854b1d981f8de5923cbbd4b72c320de5e7db0bb3b4376

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmd_gnn-0.1.2-py2.py3-none-macosx_10_13_x86_64.whl:

Publisher: release.yaml on deepmodeling/deepmd-gnn

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