Skip to content

Commit

Permalink
Use autosummary on torch.fft, torch.linalg (pytorch#55748)
Browse files Browse the repository at this point in the history
Summary:
Related to pytorch#52256

Use autosummary instead of autofunction to create subpages for `torch.fft` and `torch.linalg` functions.

zou3519

Pull Request resolved: pytorch#55748

Reviewed By: jbschlosser

Differential Revision: D27739282

Pulled By: heitorschueroff

fbshipit-source-id: 37aa06cb8959721894ffadc15ae8c3b83481a319
  • Loading branch information
mattip authored and facebook-github-bot committed Apr 13, 2021
1 parent 657b66e commit f61556a
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 40 deletions.
44 changes: 26 additions & 18 deletions docs/source/fft.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,33 @@ Discrete Fourier transforms and related functions.
Fast Fourier Transforms
-----------------------

.. autofunction:: fft
.. autofunction:: ifft
.. autofunction:: fft2
.. autofunction:: ifft2
.. autofunction:: fftn
.. autofunction:: ifftn
.. autofunction:: rfft
.. autofunction:: irfft
.. autofunction:: rfft2
.. autofunction:: irfft2
.. autofunction:: rfftn
.. autofunction:: irfftn
.. autofunction:: hfft
.. autofunction:: ihfft
.. autosummary::
:toctree: generated
:nosignatures:

fft
ifft
fft2
ifft2
fftn
ifftn
rfft
irfft
rfft2
irfft2
rfftn
irfftn
hfft
ihfft

Helper Functions
----------------

.. autofunction:: fftfreq
.. autofunction:: rfftfreq
.. autofunction:: fftshift
.. autofunction:: ifftshift
.. autosummary::
:toctree: generated
:nosignatures:

fftfreq
rfftfreq
fftshift
ifftshift
48 changes: 26 additions & 22 deletions docs/source/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,30 @@ function for details.

Functions
---------
.. autosummary::
:toctree: generated
:nosignatures:

.. autofunction:: cholesky
.. autofunction:: cond
.. autofunction:: det
.. autofunction:: slogdet
.. autofunction:: eig
.. autofunction:: eigvals
.. autofunction:: eigh
.. autofunction:: eigvalsh
.. autofunction:: matrix_power
.. autofunction:: matrix_rank
.. autofunction:: multi_dot
.. autofunction:: norm
.. autofunction:: vector_norm
.. autofunction:: pinv
.. autofunction:: svd
.. autofunction:: solve
.. autofunction:: tensorinv
.. autofunction:: tensorsolve
.. autofunction:: inv
.. autofunction:: qr
.. autofunction:: lstsq
.. autofunction:: householder_product

cholesky
cond
det
slogdet
eig
eigvals
eigh
eigvalsh
matrix_power
matrix_rank
multi_dot
norm
vector_norm
pinv
svd
solve
tensorinv
tensorsolve
inv
qr
lstsq
householder_product

0 comments on commit f61556a

Please sign in to comment.