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

Summary:
Fixes https://github.com/pytorch/pytorch/pull/44877#issuecomment-705411068

Pull Request resolved: https://github.com/pytorch/pytorch/pull/46032

Reviewed By: ngimel

Differential Revision: D24191580

Pulled By: mruberry

fbshipit-source-id: 58a32de886b40f85653ddc3b65bf8d551395f023
This commit is contained in:
Peter Bell 2020-10-08 17:53:59 -07:00 committed by Facebook GitHub Bot
parent 2b204e6db3
commit c86ee082a2
2 changed files with 11 additions and 2 deletions

View File

@ -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

View File

@ -688,6 +688,7 @@ Example:
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],