Skip to content

Commit

Permalink
[doc] Deprecate torch.cholesky in favor of torch.linalg.cholesky (#51460
Browse files Browse the repository at this point in the history
)

Summary:
Pull Request resolved: #51460

This PR is part of a larger effort to ensure torch.linalg documentation is consistent (see #50287).

* #51459 [doc] Fix linalg.cholesky doc consistency issues

Test Plan: Imported from OSS

Reviewed By: mruberry

Differential Revision: D26176130

Pulled By: heitorschueroff

fbshipit-source-id: cc89575db69cbfd5f87d970a2e71deb6522a35b1
  • Loading branch information
heitorschueroff authored and facebook-github-bot committed Feb 1, 2021
1 parent 8583f7c commit 8fa328f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions torch/_torch_docs.py
Expand Up @@ -1721,6 +1721,10 @@ def merge_dicts(*dicts):
tensor will be composed of lower-triangular Cholesky factors of each of the individual
matrices.
.. note:: :func:`torch.linalg.cholesky` should be used over ``torch.cholesky`` when possible.
Note however that :func:`torch.linalg.cholesky` does not yet support the :attr:`upper`
parameter and instead always returns the lower triangular matrix.
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 8fa328f

Please sign in to comment.