Skip to main content

Equivariant convolutional neural networks for the group E(3) of 3 dimensional rotations, translations, and mirrors.

Project description

Euclidean neural networks

Coverage Status DOI

Documentation | Code | CHANGELOG | Colab

The aim of this library is to help the development of E(3) equivariant neural networks. It contains fundamental mathematical operations such as tensor products and spherical harmonics.

Installation

Important: install pytorch and only then run the command

pip install --upgrade pip
pip install --upgrade e3nn

For details and optional dependencies, see INSTALL.md

Breaking changes

e3nn is under development. It is recommanded to install using pip. The main branch is considered as unstable. The second version number is incremented every time a breaking change is made to the code.

0.(increment when backwards incompatible release).(increment for backwards compatible release)

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 in the discussions.

Code of conduct

Our community abides by the Contributor Covenant Code of Conduct.

Citing

If you use e3nn in your research, please cite the following papers:

Euclidean Neural Networks:

  • N. Thomas et al., "Tensor field networks: Rotation- and translation-equivariant neural networks for 3D point clouds" (2018). arXiv:1802.08219
  • M. Weiler et al., "3D Steerable CNNs: Learning Rotationally Equivariant Features in Volumetric Data" (2018). arXiv:1807.02547
  • R. Kondor et al., "Clebsch-Gordan Nets: a Fully Fourier Space Spherical Convolutional Neural Network" (2018). arXiv:1806.09231

e3nn:

  • M. Geiger and T. Smidt, "e3nn: Euclidean Neural Networks" (2022). arXiv:2207.09453
  • M. Geiger et al., "Euclidean neural networks: e3nn" (2022). Zenodo

For BibTeX entries, please refer to the CITATION.bib file in this repository.

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.

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

e3nn-0.5.5.tar.gz (435.6 kB view details)

Uploaded Source

Built Distribution

e3nn-0.5.5-py3-none-any.whl (447.7 kB view details)

Uploaded Python 3

File details

Details for the file e3nn-0.5.5.tar.gz.

File metadata

  • Download URL: e3nn-0.5.5.tar.gz
  • Upload date:
  • Size: 435.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for e3nn-0.5.5.tar.gz
Algorithm Hash digest
SHA256 e91795db98d23a56b3df2532fb60d1401ce96f9b940263855b91ee7b98885435
MD5 cd1e507de8f34fd51cfa38f9d3fb4ca0
BLAKE2b-256 ecad475b03a490f169cc5e8cc3b3690efa6343129f1e81c13f28d91b8d6291ab

See more details on using hashes here.

File details

Details for the file e3nn-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: e3nn-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 447.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for e3nn-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b5182bf4360bb276df37face962afb5e90f815b9643b99b6e0114329e8418965
MD5 0df31c1f96bf7a6a099488125b578a03
BLAKE2b-256 a78a1fe7541003cb05365f5e668231dfe2ae2219097cee85d1fefa56da8878a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page