pytorch/docs/source/linalg.rst
lezcano e505796a2c [Array API] Add linalg.vecdot (#70542)
This PR adds the function `linalg.vecdot` specified by the [Array
API](https://data-apis.org/array-api/latest/API_specification/linear_algebra_functions.html#function-vecdot)

For the complex case, it chooses to implement \sum x_i y_i. See the
discussion in https://github.com/data-apis/array-api/issues/356

Edit. When it comes to testing, this function is not quite a binopt, nor a reduction opt. As such, we're this close to be able to get the extra testing, but we don't quite make it. Now, it's such a simple op that I think we'll make it without this.

Resolves https://github.com/pytorch/pytorch/issues/18027.

cc @mruberry @rgommers @pmeier @asmeurer @leofang @AnirudhDagar @asi1024 @emcastillo @kmaehashi
Pull Request resolved: https://github.com/pytorch/pytorch/pull/70542
Approved by: https://github.com/IvanYashchuk, https://github.com/mruberry
2022-07-12 14:28:54 +00:00

123 lines
1.5 KiB
ReStructuredText

.. role:: hidden
:class: hidden-section
torch.linalg
============
Common linear algebra operations.
.. automodule:: torch.linalg
.. currentmodule:: torch.linalg
Matrix Properties
-----------------
.. autosummary::
:toctree: generated
:nosignatures:
norm
vector_norm
matrix_norm
diagonal
det
slogdet
cond
matrix_rank
Decompositions
--------------
.. autosummary::
:toctree: generated
:nosignatures:
cholesky
qr
lu
lu_factor
eig
eigvals
eigh
eigvalsh
svd
svdvals
Solvers
-------
.. autosummary::
:toctree: generated
:nosignatures:
solve
solve_triangular
lu_solve
lstsq
Inverses
--------
.. autosummary::
:toctree: generated
:nosignatures:
inv
pinv
Matrix Functions
----------------
.. autosummary::
:toctree: generated
:nosignatures:
matrix_exp
matrix_power
Matrix Products
---------------
.. autosummary::
:toctree: generated
:nosignatures:
cross
matmul
vecdot
multi_dot
householder_product
Tensor Operations
-----------------
.. autosummary::
:toctree: generated
:nosignatures:
tensorinv
tensorsolve
Misc
----
.. autosummary::
:toctree: generated
:nosignatures:
vander
Experimental Functions
----------------------
.. autosummary::
:toctree: generated
:nosignatures:
cholesky_ex
inv_ex
solve_ex
lu_factor_ex
ldl_factor
ldl_factor_ex
ldl_solve