Files
pytorch/docs/source/size.rst
Tobias Ringwald 58e403c739 Added a docstring for torch.Size.numel. (#124186)
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
2024-04-19 09:23:02 +00:00

26 lines
522 B
ReStructuredText

torch.Size
===================================
:class:`torch.Size` is the result type of a call to :func:`torch.Tensor.size`. It describes the size of all dimensions
of the original tensor. As a subclass of :class:`tuple`, it supports common sequence operations like indexing and
length.
Example::
>>> x = torch.ones(10, 20, 30)
>>> s = x.size()
>>> s
torch.Size([10, 20, 30])
>>> s[1]
20
>>> len(s)
3
.. autoclass:: torch.Size
:members:
:undoc-members:
:inherited-members: