e3nn

e3nn main

🎄 The core features of the library has been rewritten in the branch ✨e3nn:main✨.

CustomWeightedTensorProduct is now TensorProduct and its method .right() replaces Kernel.
Rs lists are replaced by the more powerful Irreps object.
Rotations functions from o3 have been completed by quaternion and axis-angle support.
Spherical harmonics are implemented as tensor products Y^{l+1} = Y^l \otimes (x,y,z) and are faster.
Code examples are documented here

Intro

E(3) is the Euclidean group in dimension 3. That is the group of rotations, translations and mirror. e3nn is a pytorch library that aims to create E(3) equivariant neural networks.

Installation

After having installed pytorch_geometric run the command:

pip install e3nn

To get the CUDA kernels read the instructions in INSTALL.md.

Example

from functools import partial

import torch

from e3nn import rs
from e3nn.kernel import Kernel
from e3nn.non_linearities.norm import Norm
from e3nn.non_linearities.rescaled_act import swish
from e3nn.point.operations import Convolution
from e3nn.radial import GaussianRadialModel

# Define the input and output representations
Rs_in = [(1, 0), (2, 1)]  # Input = One scalar plus two vectors
Rs_out = [(1, 1)]  # Output = One single vector

# Radial model:  R+ -> R^d
RadialModel = partial(GaussianRadialModel, max_radius=3.0, number_of_basis=3, h=100, L=1, act=swish)

# kernel: composed on a radial part that contains the learned parameters
#  and an angular part given by the spherical hamonics and the Clebsch-Gordan coefficients
K = partial(Kernel, RadialModel=RadialModel)

# Create the convolution module
conv = Convolution(K(Rs_in, Rs_out))

# Module to compute the norm of each irreducible component
norm = Norm(Rs_out)


n = 5  # number of input points
features = rs.randn(1, n, Rs_in, requires_grad=True)
in_geometry = torch.randn(1, n, 3)
out_geometry = torch.zeros(1, 1, 3)  # One point at the origin


out = norm(conv(features, in_geometry, out_geometry))
out.backward()

print(out)
print(features.grad)

Example for point cloud: tetris

Hierarchy

e3nn contains the library
- e3nn/o3.py O(3) irreducible representations
- e3nn/rsh.py real spherical harmonics
- e3nn/rs.py geometrical tensor representations
- e3nn/image contains voxels linear operations
- e3nn/point contains points linear operations
- e3nn/non_linearities non linearities operations
examples simple scripts and experiments

Help

We are happy to help! The best way to get help on e3nn is to submit a Question or Bug Report.

Want to get involved? Great!

If you want to get involved in and contribute to the development, improvement, and application of e3nn, introduce yourself with Project Wanted.

Code of conduct

Our community abides by the Contributor Covenant Code of Conduct.

Citing

@software{e3nn_2020_3724963,
  author       = {Mario Geiger and
                  Tess Smidt and
                  Benjamin K. Miller and
                  Wouter Boomsma and
                  Kostiantyn Lapchevskyi and
                  Maurice Weiler and
                  Michał Tyszkiewicz and
                  Bradley Dice and
                  Jes Frellsen and
                  Sophia Sanborn and
                  M. Alby},
  title        = {\texttt{e3nn}: a modular framework for Euclidean Neural Networks, github.com/e3nn/e3nn}},
  month        = dec,
  year         = 2020,
  publisher    = {Zenodo},
  version      = {0.1.1},
  doi          = {10.5281/zenodo.3724963},
  url          = {https://doi.org/10.5281/zenodo.3724963}
}

Copyright

Euclidean neural networks (e3nn) Copyright (c) 2020, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Ecole Polytechnique Federale de Lausanne (EPFL), Free University of Berlin and Kostiantyn Lapchevskyi. All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.

NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.

mitkotak/e3nn