| 123456789101112131415161718192021222324252627282930313233343536373839 |
- # mypy: allow-untyped-defs
- """Adds docstrings to torch.Size functions"""
- import torch._C
- from torch._C import _add_docstr as add_docstr
- def add_docstr_all(method, docstr):
- add_docstr(getattr(torch._C.Size, method), docstr)
- add_docstr_all(
- "numel",
- """
- numel() -> int
- Returns the number of elements a :class:`torch.Tensor` with the given size would contain.
- More formally, for a tensor ``x = tensor.ones(10, 10)`` with size ``s = torch.Size([10, 10])``,
- ``x.numel() == x.size().numel() == s.numel() == 100`` holds true.
- Example::
- >>> x=torch.ones(10, 10)
- >>> s=x.size()
- >>> s
- torch.Size([10, 10])
- >>> s.numel()
- 100
- >>> x.numel() == s.numel()
- True
- .. warning::
- This function does not return the number of dimensions described by :class:`torch.Size`, but instead the number
- of elements a :class:`torch.Tensor` with that size would contain.
- """,
- )
|
