1.8 linalg doc updates

pytorch · Feb 3, 2021 · 40e8033 · 40e8033
1 parent 4b65a27
commit 40e8033
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/source/linalg.rst b/docs/source/linalg.rst
@@ -6,6 +6,10 @@ torch.linalg
 
 Common linear algebra operations.
 
+This module is in BETA. New functions are still being added, and some
+functions may change in future PyTorch releases. See the documentation of each
+function for details.
+
 .. automodule:: torch.linalg
 .. currentmodule:: torch.linalg
 

diff --git a/torch/linalg/__init__.py b/torch/linalg/__init__.py
@@ -523,7 +523,8 @@
 always be real-valued, even if :attr:`input` is complex.
 
 .. note:: Unlike NumPy's ``linalg.svd``, this always returns a namedtuple of
-          three tensors, even when :attr:`compute_uv=False`.
+          three tensors, even when :attr:`compute_uv=False`. This behavior may
+          change in a future PyTorch release.
 
 .. note:: The singular values are returned in descending order. If :attr:`input` is a batch of matrices,
           then the singular values of each matrix in the batch is returned in descending order.
@@ -914,7 +915,7 @@
 
            * unlike ``numpy.linalg.qr``, this function always returns a
              tuple of two tensors. When ``mode='r'``, the `Q` tensor is an
-             empty tensor.
+             empty tensor. This behavior may change in a future PyTorch release.
 
 .. note::
           Backpropagation is not supported for ``mode='r'``. Use ``mode='reduced'`` instead.