diff --git a/torch/_torch_docs.py b/torch/_torch_docs.py index 5f1c687069b7..673fb87fc63c 100644 --- a/torch/_torch_docs.py +++ b/torch/_torch_docs.py @@ -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.