Wavelets with JAX
==================================================================
|pypi| |license| |zenodo| |docs| |unit_tests| |coverage|
Introduction
-------------------
``CR-Wavelets`` is a port of `PyWavelets` for
`Google JAX <https://jax.readthedocs.io/en/latest/>`_.
It enables running Wavelet decomposition and reconstruction
algorithms on GPU and TPU hardware.
For detailed documentation and usage, please visit `online docs <https://cr-wavelets.readthedocs.io/en/latest>`_.
For theoretical background, please check online notes at `Topics in Signal Processing <https://tisp.indigits.com>`_
and references therein (still under development).
``CR-Wavelets`` is part of
`CR-Suite <https://carnotresearch.github.io/cr-suite/>`_.
Related libraries:
* `CR-Nimble <https://cr-nimble.readthedocs.io>`_
* `CR-Sparse <https://cr-sparse.readthedocs.io>`_
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:
.. code:: shell
python -m pip install cr-wavelets
Directly from our GITHUB repository:
.. code:: shell
python -m pip install git+https://github.com/carnotresearch/cr-wavelets.git
Examples/Usage
----------------
See the `examples gallery <https://cr-wavelets.readthedocs.io/en/latest/gallery/index.html>`_ in the documentation.
Contribution Guidelines/Code of Conduct
----------------------------------------
* `Contribution Guidelines <CONTRIBUTING.md>`_
* `Code of Conduct <CODE_OF_CONDUCT.md>`_
`Documentation <https://carnotresearch.github.io/cr-wavelets>`_ |
`Code <https://github.com/carnotresearch/cr-wavelets>`_ |
`Issues <https://github.com/carnotresearch/cr-wavelets/issues>`_ |
`Discussions <https://github.com/carnotresearch/cr-wavelets/discussions>`_ |
.. |docs| image:: https://readthedocs.org/projects/cr-wavelets/badge/?version=latest
:target: https://cr-wavelets.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |unit_tests| image:: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml/badge.svg
:alt: Unit Tests
:target: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml
.. |pypi| image:: https://badge.fury.io/py/cr-wavelets.svg
:alt: PyPI cr-wavelets
:target: https://badge.fury.io/py/cr-wavelets
.. |coverage| image:: https://codecov.io/gh/carnotresearch/cr-wavelets/branch/master/graph/badge.svg?token=JZQW6QU3S4
:alt: Coverage
:target: https://codecov.io/gh/carnotresearch/cr-wavelets
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:alt: License
:target: https://opensource.org/licenses/Apache-2.0
.. |codacy| image:: https://app.codacy.com/project/badge/Grade/36905009377e4a968124dabb6cd24aae
:alt: Codacy Badge
:target: https://www.codacy.com/gh/carnotresearch/cr-wavelets/dashboard?utm_source=github.com&utm_medium=referral&utm_content=carnotresearch/cr-wavelets&utm_campaign=Badge_Grade
.. |zenodo| image:: https://zenodo.org/badge/525693334.svg
:alt: DOI
:target: https://zenodo.org/badge/latestdoi/525693334
Raw data
{
"_id": null,
"home_page": "https://carnotresearch.github.io/cr-wavelets",
"name": "cr-wavelets",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Computer Vision",
"author": "CR-Wavelets Development Team",
"author_email": "contact@carnotresearch.com",
"download_url": "https://files.pythonhosted.org/packages/bd/51/11eae7b4660afbe8338864aee4b51fba22c6b1f16eff61f8029cbbaa8fe6/cr-wavelets-0.4.0.tar.gz",
"platform": null,
"description": "Wavelets with JAX\n==================================================================\n\n\n|pypi| |license| |zenodo| |docs| |unit_tests| |coverage|\n\n\nIntroduction\n-------------------\n\n\n``CR-Wavelets`` is a port of `PyWavelets` for\n`Google JAX <https://jax.readthedocs.io/en/latest/>`_. \nIt enables running Wavelet decomposition and reconstruction\nalgorithms on GPU and TPU hardware.\n\nFor detailed documentation and usage, please visit `online docs <https://cr-wavelets.readthedocs.io/en/latest>`_.\n\nFor theoretical background, please check online notes at `Topics in Signal Processing <https://tisp.indigits.com>`_\nand references therein (still under development).\n\n``CR-Wavelets`` is part of\n`CR-Suite <https://carnotresearch.github.io/cr-suite/>`_.\n\nRelated libraries:\n\n* `CR-Nimble <https://cr-nimble.readthedocs.io>`_\n* `CR-Sparse <https://cr-sparse.readthedocs.io>`_\n\n\n\nSupported Platforms\n----------------------\n\n``CR-Wavelets`` can run on any platform supported by ``JAX``. \nWe have tested ``CR-Wavelets`` on Mac and Linux platforms and Google Colaboratory.\n\n* The latest code in the library has been tested against JAX 0.4.\n\n``JAX`` is not officially supported on Windows platforms at the moment. \nAlthough, it is possible to build it from source using Windows Subsystems for Linux.\nAlternatively, you can check out the community supported Windows build for JAX\navailable from https://github.com/cloudhan/jax-windows-builder.\nThis seems to work well and all the unit tests in the library have passed\non Windows also. \n\nInstallation\n-------------------------------\n\nInstallation from PyPI:\n\n.. code:: shell\n\n python -m pip install cr-wavelets\n\nDirectly from our GITHUB repository:\n\n.. code:: shell\n\n python -m pip install git+https://github.com/carnotresearch/cr-wavelets.git\n\n\n\nExamples/Usage\n----------------\n\nSee the `examples gallery <https://cr-wavelets.readthedocs.io/en/latest/gallery/index.html>`_ in the documentation.\n\n\nContribution Guidelines/Code of Conduct\n----------------------------------------\n\n* `Contribution Guidelines <CONTRIBUTING.md>`_\n* `Code of Conduct <CODE_OF_CONDUCT.md>`_\n\n\n`Documentation <https://carnotresearch.github.io/cr-wavelets>`_ | \n`Code <https://github.com/carnotresearch/cr-wavelets>`_ | \n`Issues <https://github.com/carnotresearch/cr-wavelets/issues>`_ | \n`Discussions <https://github.com/carnotresearch/cr-wavelets/discussions>`_ |\n\n\n.. |docs| image:: https://readthedocs.org/projects/cr-wavelets/badge/?version=latest\n :target: https://cr-wavelets.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |unit_tests| image:: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml/badge.svg\n :alt: Unit Tests\n :target: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml\n\n\n.. |pypi| image:: https://badge.fury.io/py/cr-wavelets.svg\n :alt: PyPI cr-wavelets\n :target: https://badge.fury.io/py/cr-wavelets\n\n.. |coverage| image:: https://codecov.io/gh/carnotresearch/cr-wavelets/branch/master/graph/badge.svg?token=JZQW6QU3S4\n :alt: Coverage\n :target: https://codecov.io/gh/carnotresearch/cr-wavelets\n\n\n.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg\n :alt: License\n :target: https://opensource.org/licenses/Apache-2.0\n\n.. |codacy| image:: https://app.codacy.com/project/badge/Grade/36905009377e4a968124dabb6cd24aae\n :alt: Codacy Badge\n :target: https://www.codacy.com/gh/carnotresearch/cr-wavelets/dashboard?utm_source=github.com&utm_medium=referral&utm_content=carnotresearch/cr-wavelets&utm_campaign=Badge_Grade\n\n.. |zenodo| image:: https://zenodo.org/badge/525693334.svg\n :alt: DOI\n :target: https://zenodo.org/badge/latestdoi/525693334\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0",
"summary": "Wavelets with JAX",
"version": "0.4.0",
"project_urls": {
"Download": "https://github.com/carnotresearch/cr-wavelets/archive/v0.4.0.tar.gz",
"Homepage": "https://carnotresearch.github.io/cr-wavelets",
"Issue Tracker": "https://github.com/carnotresearch/cr-wavelets/issues"
},
"split_keywords": [
"computer",
"vision"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5248ddb3897042732e50d496705432b9923b0d1db51120af22a4573e240ffa1f",
"md5": "47ab42d6cbdf4fa98972d13899dc5d37",
"sha256": "1f6cd201d86fb27101535e0338a2bfc0676d8bc52ec672f617ee5ebd5f182736"
},
"downloads": -1,
"filename": "cr_wavelets-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47ab42d6cbdf4fa98972d13899dc5d37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 137443,
"upload_time": "2023-10-15T20:18:17",
"upload_time_iso_8601": "2023-10-15T20:18:17.911485Z",
"url": "https://files.pythonhosted.org/packages/52/48/ddb3897042732e50d496705432b9923b0d1db51120af22a4573e240ffa1f/cr_wavelets-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd5111eae7b4660afbe8338864aee4b51fba22c6b1f16eff61f8029cbbaa8fe6",
"md5": "1d00e96f35b93922f98ea6ef1759da99",
"sha256": "51459ed358323143eccbf335b68f27f1c0b1c7a8387238b4689c2843466214a4"
},
"downloads": -1,
"filename": "cr-wavelets-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "1d00e96f35b93922f98ea6ef1759da99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 127970,
"upload_time": "2023-10-15T20:18:19",
"upload_time_iso_8601": "2023-10-15T20:18:19.938801Z",
"url": "https://files.pythonhosted.org/packages/bd/51/11eae7b4660afbe8338864aee4b51fba22c6b1f16eff61f8029cbbaa8fe6/cr-wavelets-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-15 20:18:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carnotresearch",
"github_project": "cr-wavelets",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cr-wavelets"
}
JSON
