reference/generated/tensordict.TensorDictBase.logsumexp

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.logsumexp

TensorDictBase.logsumexp(dim=None, keepdim=False, *, out=None)

Returns the log of summed exponentials of each row of the input tensordict in the given dimension dim. The computation is numerically stabilized.

If keepdim is True, the output tensor is of the same size as input except in the dimension(s) dim where it is of size 1. Otherwise, dim is squeezed (see squeeze()), resulting in the output tensor having 1 (or len(dim)) fewer dimension(s).

Parameters:

• dim (int or tuple of ints, optional) – the dimension or dimensions to reduce. If None, all batch dimensions of the tensordict are reduced.

• keepdim (bool) – whether the output tensordict has dim retained or not.

Keyword Arguments:

out (TensorDictBase, optional) – the output tensordict.

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