Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Deprecate torch.cholesky in favor of torch.linalg.cholesky #51460

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions torch/_torch_docs.py
Original file line number Diff line number Diff line change
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