add note to forward and backward.

v0lta · Jul 1, 2024 · 9981521 · 9981521
1 parent cef6a04
commit 9981521
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/ptwt/separable_conv_transform.py b/src/ptwt/separable_conv_transform.py
@@ -368,6 +368,9 @@ def _fswavedecn(
         >>> from ptwt.separable_conv_transform import _fswavedecn
         >>> data = torch.randn(5, 10, 10, 10)
         >>> coeff = _fswavedecn(data, "haar", ndim=3, level=2)
+
+    Note:
+        ND-Transforms are generally out of this project's scope.
     """
     if axes is None:
         axes = tuple(range(-ndim, 0))