reference/generated/tensordict.TensorDictBase.mul

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.mul

TensorDictBase.mul(other: TensorCollection | Tensor, *, default: str | Tensor | TensorCollection | None = None) → Self

Multiplies other to self.

\[\text{out}_i = \text{input}_i \times \text{other}_i\]

Supports broadcasting, type promotion, and integer, float, and complex inputs.

Parameters:

other (TensorDict, Tensor or Number) – the tensor or number to subtract from self.

Keyword Arguments:

default (Tensor or str, optional) – the value to use for an entry that only one of the two tensordicts has. If None (default), the two tensordicts must have the same keys, and a missing key raises KeyError. If "intersection", only the keys that both tensordicts have are computed, and the other keys are dropped. Any other value replaces the missing entries on both sides of the operation.

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