[Doc] Add Tensor.Shape (pytorch#104750)

Summary: Pull Request resolved: pytorch#104750 Add `Tensor.Shape` doc. Ref: - pytorch#5544 - pytorch#1980 Differential Revision: D47278630 fbshipit-source-id: aa2466cba60b21860338e1ea6b8850f4395b6255
isdanni · Jul 25, 2023 · 990864e · 990864e
1 parent a4cffaa
commit 990864e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/source/tensors.rst b/docs/source/tensors.rst
@@ -622,6 +622,7 @@ Tensor class reference
     Tensor.asinh_
     Tensor.arcsinh
     Tensor.arcsinh_
+    Tensor.shape
     Tensor.size
     Tensor.slogdet
     Tensor.slice_scatter

diff --git a/torch/_tensor_docs.py b/torch/_tensor_docs.py
@@ -4727,6 +4727,26 @@ def callable(a, b) -> number
 """,
 )
 
+add_docstr_all(
+    "shape",
+    r"""
+shape() -> torch.Size
+
+Returns the size of the :attr:`self` tensor. Alias for :attr:`size`.
+
+See also :meth:`Tensor.size`.
+
+Example::
+
+    >>> t = torch.empty(3, 4, 5)
+    >>> t.size()
+    torch.Size([3, 4, 5])
+    >>> t.shape
+    torch.Size([3, 4, 5])
+
+""",
+)
+
 add_docstr_all(
     "sort",
     r"""