torch.fft: Add helper functions section to docs (#46032)

Summary: Fixes #44877 (comment) Pull Request resolved: #46032 Reviewed By: ngimel Differential Revision: D24191580 Pulled By: mruberry fbshipit-source-id: 58a32de886b40f85653ddc3b65bf8d551395f023
pytorch · Oct 9, 2020 · c86ee08 · c86ee08
1 parent 2b204e6
commit c86ee08
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/source/fft.rst b/docs/source/fft.rst
@@ -16,8 +16,8 @@ conflicts with the :func:`torch.fft` function.
 
 .. currentmodule:: torch.fft
 
-Functions
----------
+Fast Fourier Transforms
+-----------------------
 
 .. autofunction:: fft
 .. autofunction:: ifft
@@ -29,3 +29,11 @@ Functions
 .. autofunction:: irfftn
 .. autofunction:: hfft
 .. autofunction:: ihfft
+
+Helper Functions
+----------------
+
+.. autofunction:: fftfreq
+.. autofunction:: rfftfreq
+.. autofunction:: fftshift
+.. autofunction:: ifftshift
diff --git a/torch/fft/__init__.py b/torch/fft/__init__.py
@@ -688,6 +688,7 @@
     beginning of the tensor.
 
     This also works for multi-dimensional transforms:
+
     >>> x = torch.fft.fftfreq(5, d=1/5) + 0.1 * torch.fft.fftfreq(5, d=1/5).unsqueeze(1)
     >>> x
     tensor([[ 0.0000,  1.0000,  2.0000, -2.0000, -1.0000],