carnotresearch / cr-wavelets

Wavelets with JAX

Wavelets with JAX

Introduction

CR-Wavelets is a port of PyWavelets for Google JAX. It enables running Wavelet decomposition and reconstruction algorithms on GPU and TPU hardware.

For detailed documentation and usage, please visit online docs.

For theoretical background, please check online notes at Topics in Signal Processing and references therein (still under development).

CR-Wavelets is part of CR-Suite.

Related libraries:

• CR-Nimble
• CR-Sparse

Supported Platforms

CR-Wavelets can run on any platform supported by JAX. We have tested CR-Wavelets on Mac and Linux platforms and Google Colaboratory.

• The latest code in the library has been tested against JAX 0.4.

JAX is not officially supported on Windows platforms at the moment. Although, it is possible to build it from source using Windows Subsystems for Linux. Alternatively, you can check out the community supported Windows build for JAX available from https://github.com/cloudhan/jax-windows-builder. This seems to work well and all the unit tests in the library have passed on Windows also.

Installation

Installation from PyPI:

python -m pip install cr-wavelets

Directly from our GITHUB repository:

python -m pip install git+https://github.com/carnotresearch/cr-wavelets.git

Examples/Usage

See the examples gallery in the documentation.

Contribution Guidelines/Code of Conduct

• Contribution Guidelines
• Code of Conduct

Documentation | Code | Issues | Discussions |