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)
  • (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.3.3.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

jaxlie-1.3.3-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jaxlie-1.3.3.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for jaxlie-1.3.3.tar.gz
Algorithm Hash digest
SHA256 bf2c2bbfdb66d3063464cc0e3bd9e20c80b0593e8488ea277edb14e59713aa62
MD5 14331fc6e30a55a0d3d46b147bd41c0c
BLAKE2b-256 86f527e289d7dc7b1c1cd4088015855e8dc35f2bd1db36cfcec901fdc790b5a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jaxlie-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for jaxlie-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b24779e9d14e7626533f14f2c58af9efccbd9b4b384a8b48c128347abb269599
MD5 6630a3d00aca904be0b1121d53eaa286
BLAKE2b-256 8585475dd4d953912d918af4c738a823d6a9f4851e172f9045f7170377ae372d

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