Skip to main content

Accelerated sparse representations and compressive sensing

Project description

PyPI cr-sparse License DOI Documentation Status Unit Tests Coverage JOSS

Introduction

CR-Sparse is a Python library that enables efficiently solving a wide variety of sparse representation based signal processing problems. It is a cohesive collection of sub-libraries working together. Individual sub-libraries provide functionalities for: wavelets, linear operators, greedy and convex optimization based sparse recovery algorithms, subspace clustering, standard signal processing transforms, and linear algebra subroutines for solving sparse linear systems. It has been built using Google JAX, which enables the same high level Python code to get efficiently compiled on CPU, GPU and TPU architectures using XLA.

docs/images/srr_cs.png

For detailed documentation and usage, please visit online docs.

Supported Platforms

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

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.

Installation

Installation from PyPI:

python -m pip install cr-sparse

Directly from our GITHUB repository:

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

Examples/Usage

See the examples gallery in the documentation. Here is a small selection of examples:

A more extensive collection of example notebooks is available in the companion repository. Some micro-benchmarks are reported here.

Contribution Guidelines/Code of Conduct

Citing CR-Sparse

To cite this repository:

@software{crsparse2021github,
author = {Shailesh Kumar},
title = {{CR-Sparse}: Functional Models and Algorithms for Sparse Signal Processing},
url = {https://cr-sparse.readthedocs.io/en/latest/},
version = {0.2.1},
year = {2021},
doi={10.5281/zenodo.5322044},
}

Documentation | Code | Issues | Discussions |

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

cr-sparse-0.2.2.tar.gz (2.3 MB view hashes)

Uploaded Source

Built Distribution

cr_sparse-0.2.2-py3-none-any.whl (330.7 kB view hashes)

Uploaded Python 3

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