mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
58e403c739
Fixes #61231. Fixes #124167. This PR documents a rather long-standing issue w.r.t. unexpected behavior of `torch.Size.numel`, first reported almost 5 years ago. Pull Request resolved: https://github.com/pytorch/pytorch/pull/124186 Approved by: https://github.com/janeyx99
39 lines
881 B
Python
39 lines
881 B
Python
"""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.
|
|
|
|
""",
|
|
)
|