Skip to main content

Matrix Lie groups in JAX

Project description

jaxlie

build mypy lint codecov pypi_dowlnoads

[ API reference ] [ PyPI ]

jaxlie is a library containing implementations of Lie groups commonly used for rigid body transformations, targeted at computer vision & robotics applications written in JAX. Heavily inspired by the C++ library Sophus.

We implement Lie groups as high-level (data)classes:

Group Description Parameterization
jaxlie.SO2 Rotations in 2D. (real, imaginary): unit complex (∈ S1)
jaxlie.SE2 Proper rigid transforms in 2D. (real, imaginary, x, y): unit complex & translation
jaxlie.SO3 Rotations in 3D. (qw, qx, qy, qz): wxyz quaternion (∈ S3)
jaxlie.SE3 Proper rigid transforms in 3D. (qw, qx, qy, qz, x, y, z): wxyz quaternion & translation

Where each group supports:

  • Forward- and reverse-mode AD-friendly exp(), log(), adjoint(), apply(), multiply(), inverse(), identity(), from_matrix(), and as_matrix() operations. (see ./examples/se3_example.py)
  • Helpers for optimization on manifolds (see ./examples/se3_optimization.py, jaxlie.manifold.*).
  • Compatibility with standard JAX function transformations. (see ./examples/vmap_example.py)
  • Broadcasting for leading axes.
  • (Un)flattening as pytree nodes.
  • Serialization using flax.

We also implement various common utilities for things like uniform random sampling (sample_uniform()) and converting from/to Euler angles (in the SO3 class).


Install (Python >=3.7)

# Python 3.6 releases also exist, but are no longer being updated.
pip install jaxlie

In the wild


Misc

jaxlie was originally written for our IROS 2021 paper (link). If it's useful for you, you're welcome to cite:

@inproceedings{yi2021iros,
    author={Brent Yi and Michelle Lee and Alina Kloss and Roberto Mart\'in-Mart\'in and Jeannette Bohg},
    title = {Differentiable Factor Graph Optimization for Learning Smoothers},
    year = 2021,
    BOOKTITLE = {2021 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)}
}

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

jaxlie-1.4.0.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

jaxlie-1.4.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file jaxlie-1.4.0.tar.gz.

File metadata

  • Download URL: jaxlie-1.4.0.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for jaxlie-1.4.0.tar.gz
Algorithm Hash digest
SHA256 64aa60f652a163b2d40e2ed506475519b88a89b598cc536667c1888f07968049
MD5 0475225816a83acf42f6f39870bce92c
BLAKE2b-256 6927ba9ea422b638355cc4239064a4d85e0499182fad1f7f8715294630259bf7

See more details on using hashes here.

File details

Details for the file jaxlie-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: jaxlie-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for jaxlie-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a24511456e3c340b6d9bd419023ca4690482a54b1531123a1438eac7fa1d14ec
MD5 72b4a65136ff38acadd9cce10ea63b34
BLAKE2b-256 f2defa0a2ec2baf7e0b6b3ccac18db38035beaa3af73261b58aa7ee80a7502f6

See more details on using hashes here.

Supported by

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