This package implements the Allegro E(3)-equivariant machine-learning interatomic potential (https://arxiv.org/abs/2204.05249).
🔴 PLEASE NOTE 🔴: Please note that a major update to this code is in the final stages of development and as a result support for the current release is a lower priority.
In particular, allegro implements the Allegro model as an extension package to the NequIP package.
Please note that this package CANNOT be installed from PyPI as pip install allegro.
allegro requires the nequip package and its dependencies; please see the NequIP installation instructions for details.
Once nequip is installed, you can install allegro from source by running:
git clone --depth 1 https://github.com/mir-group/allegro.git
cd allegro
pip install .The best way to learn how to use Allegro is through the Colab Tutorial. This will run entirely on Google's cloud virtual machine, you do not need to install or run anything locally.
Allegro models are trained, evaluated, deployed, etc. identically to NequIP models using the nequip-* commands. See the NequIP README for details.
The key difference between using an Allegro and NequIP model is in the options used to define the model. We provide two Allegro config files analogous to those in nequip:
configs/minimal.yaml: A minimal example of training a toy model on force data.configs/example.yaml: Training a more realistic model on forces and energies. Start here for real models!
The key option that tells nequip to build an Allegro model is the model_builders option, which we set to:
model_builders:
- allegro.model.Allegro
# the typical model builders from `nequip` are still used to wrap the core Allegro energy model:
- PerSpeciesRescale
- ForceOutput
- RescaleEnergyEtcWe offer a LAMMPS plugin pair_allegro to use Allegro models in LAMMPS simulations, including support for Kokkos acceleration and MPI and parallel simulations. Please see the pair_allegro repository for more details.
The Allegro model and the theory behind it is described in our pre-print:
Learning Local Equivariant Representations for Large-Scale Atomistic Dynamics
Albert Musaelian, Simon Batzner, Anders Johansson, Lixin Sun, Cameron J. Owen, Mordechai Kornbluth, Boris Kozinsky
https://arxiv.org/abs/2204.05249
https://doi.org/10.48550/arXiv.2204.05249
The implementation of Allegro is built on NequIP [1], our framework for E(3)-equivariant interatomic potentials, and e3nn, [2] a general framework for building E(3)-equivariant neural networks. If you use this repository in your work, please consider citing the NequIP code [1] and e3nn [3] as well:
We can be reached by email at allegro-nequip@g.harvard.edu.
If you find a bug or have a proposal for a feature, please post it in the Issues. If you have a question, topic, or issue that isn't obviously one of those, try our GitHub Disucssions.
If your post is related to the general NequIP framework/package, please post in the issues/discussion on that repository. Discussions on this repository should be specific to the allegro package and Allegro model.
If you want to contribute to the code, please read CONTRIBUTING.md from the nequip repository; this repository follows all the same processes.