Skip to main content

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

Project description

e3nn

Coverage Status DOI

Documentation | Code | ChangeLog | Colab

The aim of this library it to help the developement of E3 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 e3nn

It is recommanded to install using pip. The main branch is considered as unstable.

For details and optional dependencies, see INSTALL.md

Breaking changes

e3nn is under development. 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)

Previous version

e3nn has been recently refactored. The last version before refactoring can be installed with the command pip install e3nn==0.1.1

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{mario_geiger_2021_4735637,
  author       = {Mario Geiger and
                  Tess Smidt and
                  Alby M. and
                  Benjamin Kurt Miller and
                  Wouter Boomsma and
                  Bradley Dice and
                  Kostiantyn Lapchevskyi and
                  Maurice Weiler and
                  Michał Tyszkiewicz and
                  Simon Batzner and
                  Jes Frellsen and
                  Nuri Jung and
                  Sophia Sanborn and
                  Josh Rackers and
                  Michael Bailey},
  title        = {e3nn/e3nn: 2021-05-04},
  month        = may,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {0.2.9},
  doi          = {10.5281/zenodo.4735637},
  url          = {https://doi.org/10.5281/zenodo.4735637}
}

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.3.0.tar.gz (355.1 kB view details)

Uploaded Source

Built Distribution

e3nn-0.3.0-py3-none-any.whl (377.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: e3nn-0.3.0.tar.gz
  • Upload date:
  • Size: 355.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for e3nn-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5e2c58f072084b79285019d8a1e3731cea47112e3cb20a28929a062a132c627e
MD5 587a3f26491316ed387068b628836d92
BLAKE2b-256 7d6b0440a4a229fd9d2eaf134b874ba2587ca6183de7002cf4d371301dae3c2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: e3nn-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 377.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for e3nn-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03e5e7c8eb2841a1fd261cfc0d6d4650342e3b6f541ce2e82992bbe5cb2c3c3b
MD5 a396a3f1cbb27db08c0befb0b1fed5e5
BLAKE2b-256 0d9e20b3c004994232b0eaa87112438f72a0f0d877762af8e038097ec5d944d9

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