Skip to content

Commit

Permalink
[doc] Deprecate torch.cholesky in favor of torch.linalg.cholesky
Browse files Browse the repository at this point in the history
ghstack-source-id: aa343d741c0114a4e38448d3d215080bc3825f71
Pull Request resolved: #51460
  • Loading branch information
heitorschueroff committed Feb 1, 2021
1 parent a38ca3c commit 2fb916b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions torch/_torch_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1721,6 +1721,11 @@ def merge_dicts(*dicts):
tensor will be composed of lower-triangular Cholesky factors of each of the individual
matrices.
.. note:: ``torch.cholesky`` is deprecated. Please use :func:`torch.linalg.cholesky` instead.
**Differences with** ``torch.linalg.cholesky``:
* :func:`torch.linalg.cholesky` does not have the :attr:``upper`` parameter and
always returns a lower triangular matrix instead.
Args:
input (Tensor): the input tensor :math:`A` of size :math:`(*, n, n)` where `*` is zero or more
batch dimensions consisting of symmetric positive-definite matrices.
Expand Down

0 comments on commit 2fb916b

Please sign in to comment.