summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorVishwak Srinivasan <cs15btech11043@iith.ac.in>2019-03-29 00:27:48 -0700
committerFacebook Github Bot <facebook-github-bot@users.noreply.github.com>2019-03-29 00:34:30 -0700
commitd859031ebf5a4e45ad950c5cd53b1dc1df5c4136 (patch)
treeff9ed2b079ecf08f666dba6a020a10939a081064 /docs
parentc21e763cd6723a50d5acb50fed0f54252cf316ff (diff)
downloadpytorch-d859031ebf5a4e45ad950c5cd53b1dc1df5c4136.tar.gz
pytorch-d859031ebf5a4e45ad950c5cd53b1dc1df5c4136.tar.bz2
pytorch-d859031ebf5a4e45ad950c5cd53b1dc1df5c4136.zip
Rename `btrifact*` to `lu` (#18435)
Summary: Changelog: - Renames `btrifact` and `btrifact_with_info` to `lu`to remain consistent with other factorization methods (`qr` and `svd`). - Now, we will only have one function and methods named `lu`, which performs `lu` decomposition. This function takes a get_infos kwarg, which when set to True includes a infos tensor in the tuple. - Rename all tests, fix callsites - Create a tentative alias for `lu` under the name `btrifact` and `btrifact_with_info`, and add a deprecation warning to not promote usage. - Add the single batch version for `lu` so that users don't have to unsqueeze and squeeze for a single square matrix (see changes in determinant computation in `LinearAlgebra.cpp`) Pull Request resolved: https://github.com/pytorch/pytorch/pull/18435 Differential Revision: D14680352 Pulled By: soumith fbshipit-source-id: af58dfc11fa53d9e8e0318c720beaf5502978cd8
Diffstat (limited to 'docs')
-rw-r--r--docs/source/tensors.rst1
-rw-r--r--docs/source/torch.rst1
2 files changed, 2 insertions, 0 deletions
diff --git a/docs/source/tensors.rst b/docs/source/tensors.rst
index 2bba064b31..b9ad547411 100644
--- a/docs/source/tensors.rst
+++ b/docs/source/tensors.rst
@@ -306,6 +306,7 @@ view of a storage and defines numeric operations on it.
.. automethod:: long
.. automethod:: lt
.. automethod:: lt_
+ .. automethod:: lu
.. automethod:: map_
.. automethod:: masked_scatter_
.. automethod:: masked_scatter
diff --git a/docs/source/torch.rst b/docs/source/torch.rst
index 101312817c..30a09dccaa 100644
--- a/docs/source/torch.rst
+++ b/docs/source/torch.rst
@@ -315,6 +315,7 @@ BLAS and LAPACK Operations
.. autofunction:: det
.. autofunction:: logdet
.. autofunction:: slogdet
+.. autofunction:: lu
.. autofunction:: matmul
.. autofunction:: matrix_power
.. autofunction:: matrix_rank