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.

Sign up for GitHub

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

Jump to bottom

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

Closed
wants to merge 2 commits into from
Closed

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e03857
[doc] Deprecate torch.cholesky in favor of torch.linalg.cholesky
heitorschueroff Feb 1, 2021
75403f7
Update on "[doc] Deprecate torch.cholesky in favor of torch.linalg.ch…
heitorschueroff Feb 1, 2021
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
5 changes: 5 additions & 0 deletions torch/_torch_docs.py
View file
Open in desktop
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.
heitorschueroff marked this conversation as resolved.
Show resolved Hide resolved
**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