Skip to main content
GitHub Actions Documentation Status PyPI Versions PyPI - Project PyPI - License Black code style

Differentiable and GPU-enabled fast wavelet transforms in JAX.

Features

  • 1d analysis and synthesis transforms are implemented in src/jaxwt/conv_fwt.py.

  • 2d analysis and synthesis transform are part of the src/jaxwt/conv_fwt_2d.py module.

  • cwt-function supports 1d continuous wavelet transforms.

  • The WaveletPacket object supports 1d wavelet packet transforms.

  • WaveletPacket2d implements two-dimensional wavelet packet transforms.

This toolbox extends PyWavelets . We additionally provide GPU and gradient support via a Jax backend.

Installation

To install Jax, head over to https://github.com/google/jax#installation and follow the procedure described there. Afterward, type pip install jaxwt to install the Jax-Wavelet-Toolbox. You can uninstall it later by typing pip uninstall jaxwt.

Documentation

The documentation is available at: https://jax-wavelet-toolbox.readthedocs.io .

Transform Examples:

One-dimensional fast wavelet transform:

import pywt
import numpy as np;
import jax.numpy as jnp
import jaxwt as jwt
# generate an input of even length.
data = jnp.array([0., 1, 2, 3, 4, 5, 6, 7, 7, 6, 5, 4, 3, 2, 1, 0])
wavelet = pywt.Wavelet('haar')

# compare the forward fwt coefficients
print(pywt.wavedec(np.array(data), wavelet, mode='zero', level=2))
print(jwt.wavedec(data, wavelet, mode='zero', level=2))

# invert the fwt.
print(jwt.waverec(jwt.wavedec(data, wavelet, mode='zero', level=2),
                  wavelet))

Two-dimensional fast wavelet transform:

import pywt, scipy.datasets
import jaxwt as jwt
import jax.numpy as jnp
face = jnp.transpose(
    scipy.datasets.face(), [2, 0, 1]).astype(jnp.float64)
transformed = jwt.wavedec2(face, pywt.Wavelet("haar"),
                           level=2, mode="reflect")
reconstruction = jwt.waverec2(transformed, pywt.Wavelet("haar"))
jnp.max(jnp.abs(face - reconstruction))

Testing

Unit tests are handled by nox. Clone the repository and run it with the following:

$ pip install nox
$ git clone https://github.com/v0lta/Jax-Wavelet-Toolbox
$ cd Jax-Wavelet-Toolbox
$ nox -s test

Goals

  • In the spirit of Jax, the aim is to be 100% pywt compatible. Whenever possible, interfaces should be the same results identical.

64-Bit floating-point numbers

If you need 64-bit floating point support, set the Jax config flag:

from jax.config import config
config.update("jax_enable_x64", True)

Citation

If you use this work in a scientific context, please cite:

@phdthesis{handle:20.500.11811/9245,
  urn: https://nbn-resolving.org/urn:nbn:de:hbz:5-63361,
  author = {{Moritz Wolter}},
  title = {Frequency Domain Methods in Recurrent Neural Networks for Sequential Data Processing},
  school = {Rheinische Friedrich-Wilhelms-Universität Bonn},
  year = 2021,
  month = jul,
  url = {https://hdl.handle.net/20.500.11811/9245}
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jaxwt-0.0.8.post1.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jaxwt-0.0.8.post1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file jaxwt-0.0.8.post1.tar.gz.

File metadata

  • Download URL: jaxwt-0.0.8.post1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for jaxwt-0.0.8.post1.tar.gz
Algorithm Hash digest
SHA256 73e0d642864f6bf41be1928660fb9b472008f9679c4b735eb9bbff11a0a1f971
MD5 4f2af6b5f33ab3fb854d7433ea046a41
BLAKE2b-256 2e7cf77ac38f4dc2300dc0543f8cebbe373fee6f0f991add91b32de1b1f9db46

See more details on using hashes here.

File details

Details for the file jaxwt-0.0.8.post1-py3-none-any.whl.

File metadata

  • Download URL: jaxwt-0.0.8.post1-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for jaxwt-0.0.8.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 178bdbac2a41775cefadb8d908aa6eb4ac1cdfacffd51cc8fae9c460fe62a451
MD5 46388496c0d8f8e93d1c07de22d4a00a
BLAKE2b-256 e0d12816c5bf6b54546282e47c1642504131e85eec7bda95129a98b814116bc5

See more details on using hashes here.

Supported by

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