reference/generated/tensordict.TensorDictBase.numel

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.numel

TensorDictBase.numel() → int

Returns the number of elements in the batch, which is the product of batch_size.

The feature dimensions of the leaves do not count. The minimum is 1: a tensordict with batch size [] or [0] returns 1, unlike torch.Tensor.numel(), which returns 0 for a size of 0.

Examples

>>> import torch
>>> from tensordict import TensorDict
>>> TensorDict(a=torch.zeros(2, 3, 10), batch_size=[2, 3]).numel()
6
>>> TensorDict(batch_size=[]).numel()
1

Every tensordict class and every tensorclass has this method. For the other methods, see Methods by task.