CR-Sparse

CR-Sparse: Hardware accelerated functional algorithms for sparse signal processing in Python using JAX - Published in JOSS (2021)

https://github.com/carnotresearch/cr-sparse

Keywords

Repository

Functional models and algorithms for sparse signal processing

README.rst

Functional Models and Algorithms for Sparse Signal Processing   
==================================================================


|pypi| |license| |zenodo| |docs| |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 `_. 

.. image:: docs/images/srr_cs.png

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-Sparse`` is part of
`CR-Suite `_.

Related libraries:

* `CR-Nimble `_
* `CR-Wavelets `_


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.

* 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:

.. code:: shell

    python -m pip install cr-sparse

Directly from our GITHUB repository:

.. code:: shell

    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:

* `Sparse recovery using Truncated Newton Interior Points Method `_ 
* `Sparse recovery with ADMM `_ 
* `Compressive sensing operators `_ 
* `Image deblurring with LSQR and FISTA algorithms `_ 
* `Deconvolution of the effects of a Ricker wavelet `_ 
* `Wavelet transform operators `_ 
* `CoSaMP step by step `_ 


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


Contribution Guidelines/Code of Conduct
----------------------------------------

* `Contribution Guidelines `_
* `Code of Conduct `_

Citing CR-Sparse
------------------------


To cite this library:

.. code:: tex

    @article{Kumar2021,
      doi = {10.21105/joss.03917},
      url = {https://doi.org/10.21105/joss.03917},
      year = {2021},
      publisher = {The Open Journal},
      volume = {6},
      number = {68},
      pages = {3917},
      author = {Shailesh Kumar},
      title = {CR-Sparse: Hardware accelerated functional algorithms for sparse signal processing in Python using JAX},
      journal = {Journal of Open Source Software}
    }




`Documentation `_ | 
`Code `_ | 
`Issues `_ | 
`Discussions `_ |


.. |docs| image:: https://readthedocs.org/projects/cr-sparse/badge/?version=latest
    :target: https://cr-sparse.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
    :scale: 100%

.. |unit_tests| image:: https://github.com/carnotresearch/cr-sparse/actions/workflows/ci.yml/badge.svg
    :alt: Unit Tests
    :scale: 100%
    :target: https://github.com/carnotresearch/cr-sparse/actions/workflows/ci.yml


.. |pypi| image:: https://badge.fury.io/py/cr-sparse.svg
    :alt: PyPI cr-sparse
    :scale: 100%
    :target: https://badge.fury.io/py/cr-sparse

.. |coverage| image:: https://codecov.io/gh/carnotresearch/cr-sparse/branch/master/graph/badge.svg?token=JZQW6QU3S4
    :alt: Coverage
    :scale: 100%
    :target: https://codecov.io/gh/carnotresearch/cr-sparse


.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :alt: License
    :scale: 100%
    :target: https://opensource.org/licenses/Apache-2.0

.. |codacy| image:: https://app.codacy.com/project/badge/Grade/36905009377e4a968124dabb6cd24aae
    :alt: Codacy Badge
    :scale: 100%
    :target: https://www.codacy.com/gh/carnotresearch/cr-sparse/dashboard?utm_source=github.com&utm_medium=referral&utm_content=carnotresearch/cr-sparse&utm_campaign=Badge_Grade

.. |zenodo| image:: https://zenodo.org/badge/323566858.svg
    :alt: DOI
    :scale: 100%
    :target: https://zenodo.org/badge/latestdoi/323566858

.. |joss| image:: https://joss.theoj.org/papers/ebd4e5ca27a5db705b1dc382b64e0bed/status.svg
    :alt: JOSS
    :scale: 100%
    :target: https://joss.theoj.org/papers/ebd4e5ca27a5db705b1dc382b64e0bed

Owner

JOSS Publication

CR-Sparse: Hardware accelerated functional algorithms for sparse signal processing in Python using JAX

Published

December 02, 2021

DOI

10.21105/joss.03917

Volume 6, Issue 68, Page 3917

Authors

Shailesh Kumar
Indian Institute of Technology, Delhi

Editor

Pierre de Buyl

Tags

sparse and redundant representations compressive sensing wavelets linear operators sparse subspace clustering functional programming

View PDF Review Thread Software Archive

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Kumar
    given-names: Shailesh
    orcid: https://orcid.org/0000-0003-2217-4768
title: "CR-Sparse: Functional Models and Algorithms for Sparse Signal Processing"
doi: 10.5281/zenodo.7066359
url: https://github.com/carnotresearch/cr-sparse
year: 2022
version: 0.3.1
preferred-citation:
  type: article
  authors:
  - family-names: "Kumar"
    given-names: "Shailesh"
    orcid: "https://orcid.org/0000-0003-2217-4768"
  doi: "10.21105/joss.03917"
  journal: "Journal of Open Source Software"
  publisher: "The Open Journal"
  url: "https://doi.org/10.21105/joss.03917"
  pages: 3917
  title: "CR-Sparse: Hardware accelerated functional algorithms for sparse signal processing in Python using JAX"
  volume: 6
  year: 2021

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "Code",
  "author": [
    {
      "@id": "0000-0003-2217-4768",
      "@type": "Person",
      "email": "shaileshk@gmail.com",
      "name": "Shailesh Kumar",
      "affiliation": "Indian Institute of Technology, Delhi"
    }
  ],
  "identifier": "",
  "codeRepository": "https://github.com/carnotresearch/cr-sparse",
  "datePublished": "2021-10-28",
  "dateModified": "2021-10-28",
  "dateCreated": "2021-10-28",
  "description": "Functional models and algorithms for sparse signal processing",
  "keywords": "functional programming, sparse linear systems, convex optimization, compressive sensing, sparse recovery, wavelets, jax, sparse subspace clustering",
  "license": "Apache 2.0",
  "title": "CR-Sparse",
  "version": "0.2.0"
}

GitHub Events

Committers

Last synced: 5 months ago

Issues and Pull Requests

Last synced: 4 months ago

Packages