update docs.

v0lta · Feb 24, 2022 · 122e2da · 122e2da
1 parent ec5c922
commit 122e2da
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,5 +1,13 @@
-ptwt
-====
+Pytorch Wavelet Toolbox (`ptwt`)
+================================
+
+The Toolbox provides padded fast wavelet transforms
+in the `conv_transform` module. The `matmul_transform` module supports boundary wavelets. 
+The `packet` module supports forward-packets transforms.
+The `sparse_math` module provides utility functions for the boundary
+wavelet transforms. Finally, the experimental `learnable_wavelets`
+module supports gradient descent optimization of wavelet filters
+with soft constraints.
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/ptwt.rst b/docs/ptwt.rst
@@ -57,10 +57,4 @@ ptwt.wavelets\_learnable module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
 
-.. automodule:: ptwt
-   :members:
-   :undoc-members:
-   :show-inheritance: