isin

class tensordict.utils.isin(input: TensorDictBase, reference: TensorDictBase, key: NestedKey, dim: int = 0)

测试 input 中 key 的每个元素是否也存在于 reference 中。

此函数返回一个长度为 input.batch_size[dim] 的布尔张量，当 entry key 中的元素也存在于 reference 中时，该元素为 True。此函数假定 input 和 reference 具有相同的 batch size 并包含指定的 entry，否则将引发错误。

参数:

• input (TensorDictBase) – 输入 TensorDict。

• reference (TensorDictBase) – 用于测试的目标 TensorDict。

• key (Nestedkey) – 要测试的键。

• dim (int, optional) – 用于测试的维度。默认为 0。

返回:

一个长度为 input.batch_size[dim] 的布尔张量，对于 input key 张量中也存在于 reference 中的元素，该元素为 True。

the input key tensor that are also present in the reference.

返回类型:

out (Tensor)

示例

>>> td = TensorDict(
...     {
...         "tensor1": torch.tensor([[1, 2, 3], [4, 5, 6], [1, 2, 3], [7, 8, 9]]),
...         "tensor2": torch.tensor([[10, 20], [30, 40], [40, 50], [50, 60]]),
...     },
...     batch_size=[4],
... )
>>> td_ref = TensorDict(
...     {
...         "tensor1": torch.tensor([[1, 2, 3], [4, 5, 6], [10, 11, 12]]),
...         "tensor2": torch.tensor([[10, 20], [30, 40], [50, 60]]),
...     },
...     batch_size=[3],
... )
>>> in_reference = isin(td, td_ref, key="tensor1")
>>> expected_in_reference = torch.tensor([True, True, True, False])
>>> torch.testing.assert_close(in_reference, expected_in_reference)