Skip to content

Commit cd71d17

Browse files
authored
Merge pull request #59 from v0lta/favicon-in-readme
Favicon in readme
2 parents b5a3e71 + dff803d commit cd71d17

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
.. |favicon| image:: https://raw.githubusercontent.com/v0lta/PyTorch-Wavelet-Toolbox/main/docs/favicon/favicon.ico
2+
:alt: Shannon-wavelet favicon
3+
:width: 32
4+
:target: https://pypi.org/project/ptwt/
5+
16
********************************
2-
Pytorch Wavelet Toolbox (`ptwt`)
7+
|favicon| Pytorch Wavelet Toolbox (`ptwt`)
38
********************************
49

510
.. image:: https://github.com/v0lta/PyTorch-Wavelet-Toolbox/actions/workflows/tests.yml/badge.svg
@@ -30,8 +35,6 @@ Pytorch Wavelet Toolbox (`ptwt`)
3035
:target: https://pepy.tech/project/ptwt
3136

3237

33-
34-
3538
Welcome to the PyTorch wavelet toolbox. This package implements:
3639

3740
- the fast wavelet transform (fwt) via ``wavedec`` and its inverse by providing the ``waverec`` function,
@@ -45,7 +48,7 @@ Welcome to the PyTorch wavelet toolbox. This package implements:
4548
- single and two-dimensional wavelet packet forward and backward transforms are available via the ``WaveletPacket`` and ``WaveletPacket2D`` objects,
4649
- finally, this package provides adaptive wavelet support (experimental).
4750

48-
This toolbox extends `PyWavelets <https://pywavelets.readthedocs.io/en/latest/>`_. We additionally provide GPU and gradient support via a PyTorch backend.
51+
This toolbox extends `PyWavelets <https://pywavelets.readthedocs.io/en/latest/>`_. In addition to boundary wavelets, we provide GPU and gradient support via a PyTorch backend.
4952
Complete documentation is available at: https://pytorch-wavelet-toolbox.readthedocs.io/
5053

5154

0 commit comments

Comments
 (0)