Skip to content

Commit 122e2da

Browse files
committed
update docs.
1 parent ec5c922 commit 122e2da

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

docs/modules.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
ptwt
2-
====
1+
Pytorch Wavelet Toolbox (`ptwt`)
2+
================================
3+
4+
The Toolbox provides padded fast wavelet transforms
5+
in the `conv_transform` module. The `matmul_transform` module supports boundary wavelets.
6+
The `packet` module supports forward-packets transforms.
7+
The `sparse_math` module provides utility functions for the boundary
8+
wavelet transforms. Finally, the experimental `learnable_wavelets`
9+
module supports gradient descent optimization of wavelet filters
10+
with soft constraints.
311

412
.. toctree::
513
:maxdepth: 4

docs/ptwt.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,4 @@ ptwt.wavelets\_learnable module
5757
:undoc-members:
5858
:show-inheritance:
5959

60-
Module contents
61-
---------------
6260

63-
.. automodule:: ptwt
64-
:members:
65-
:undoc-members:
66-
:show-inheritance:

0 commit comments

Comments
 (0)