RewardData¶

class torchrl.data.RewardData(input_ids: 'torch.Tensor', attention_mask: 'torch.Tensor', rewards: 'Optional[torch.Tensor]' = None, end_scores: 'Optional[torch.Tensor]' = None, *, batch_size, device=None, names=None)[源代码]¶

property batch_size: Size¶

检索张量类的批大小。

返回值:: 批大小 (torch.Size)

property device: device¶: 检索张量类的设备类型。

classmethod from_tensordict(tensordict, non_tensordict=None)¶

张量类包装器，用于实例化新的张量类对象。

参数:

tensordict (TensorDict) – 张量类型的字典
non_tensordict (dict) – 包含非张量和嵌套张量类对象的字典

get(key: NestedKey, default: Any = _NoDefault.ZERO)¶

获取使用输入键存储的值。

参数:

key (str, str 元组) – 要查询的键。如果为 str 元组，则等效于 getattr 的链接调用。
default – 如果在 tensorclass 中找不到键，则为默认值。

返回值:

使用输入键存储的值

classmethod load(prefix: str | Path, *args, **kwargs) → T¶

从磁盘加载 tensordict。

此类方法是 load_memmap() 的代理。

load_(prefix: str | Path, *args, **kwargs)¶

在当前 tensordict 中从磁盘加载 tensordict。

此类方法是 load_memmap_() 的代理。

classmethod load_memmap(prefix: str | Path, device: torch.device | None = None, non_blocking: bool = False, *, out: TensorDictBase | None = None) → T¶

从磁盘加载内存映射的 tensordict。

参数:

prefix (str 或 文件夹路径) – 保存的 tensordict 应从中获取的文件夹的路径。
device (torch.device 或 等效项, 可选) – 如果提供，数据将异步转换为该设备。支持 “meta” 设备，在这种情况下，数据不会加载，而是创建一组空的“meta”张量。这对于在不实际打开任何文件的情况下了解模型的总大小和结构很有用。
non_blocking (bool, 可选) – 如果 True，则在设备上加载张量后不会调用同步操作。默认为 False。
out (TensorDictBase, 可选) – 可选的 tensordict，数据将写入其中。

示例

>>> from tensordict import TensorDict
>>> td = TensorDict.fromkeys(["a", "b", "c", ("nested", "e")], 0)
>>> td.memmap("./saved_td")
>>> td_load = TensorDict.load_memmap("./saved_td")
>>> assert (td == td_load).all()

此方法也允许加载嵌套的 tensordict。

>>> nested = TensorDict.load_memmap("./saved_td/nested")
>>> assert nested["e"] == 0

tensordict 也可以加载到“meta”设备上，或者作为伪张量。

>>> import tempfile
>>> td = TensorDict({"a": torch.zeros(()), "b": {"c": torch.zeros(())}})
>>> with tempfile.TemporaryDirectory() as path:
...     td.save(path)
...     td_load = TensorDict.load_memmap(path, device="meta")
...     print("meta:", td_load)
...     from torch._subclasses import FakeTensorMode
...     with FakeTensorMode():
...         td_load = TensorDict.load_memmap(path)
...         print("fake:", td_load)
meta: TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=meta,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=meta,
    is_shared=False)
fake: TensorDict(
    fields={
        a: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=cpu,
    is_shared=False)

load_state_dict(state_dict: dict[str, Any], strict=True, assign=False, from_flatten=False)¶: 尝试在目标张量类上就地加载 state_dict。

memmap(prefix: str | None = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

将所有张量写入新 tensordict 中对应的内存映射张量。

参数:

prefix (str) – 内存映射张量将存储的目录前缀。目录树结构将模拟 tensordict 的结构。
copy_existing (bool) – 如果为 False（默认），如果 tensordict 中的条目已经是磁盘上存储的张量，并具有关联的文件，但未根据前缀保存在正确的位置，则会引发异常。如果 True，任何现有张量都将复制到新位置。

关键字参数：

num_threads (int, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (bool, 可选) – 如果 True 且 num_threads>0，则该方法将返回 tensordict 的 future。
share_non_tensor (bool, 可选) – 如果 True，则非张量数据将在进程之间共享，并且在单个节点内的任何工作程序上进行写入操作（例如就地更新或设置）将更新所有其他工作程序上的值。如果非张量叶节点的数量很高（例如，共享大量非张量数据），这可能会导致 OOM 或类似错误。默认为 False。

然后锁定 TensorDict，这意味着任何非就地的写入操作都将引发异常（例如，重命名、设置或删除条目）。解锁 tensordict 后，内存映射属性将变为 False，因为跨进程身份不再保证。

返回值:: 如果 return_early=False，则为一个包含磁盘上存储的张量的新的 tensordict，否则为 TensorDictFuture 实例。

注意

以这种方式序列化对于深度嵌套的 tensordict 来说可能很慢，因此不建议在训练循环内调用此方法。

memmap_(prefix: str | None = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

就地将所有张量写入对应的内存映射张量。

参数:

prefix (str) – 内存映射张量将存储的目录前缀。目录树结构将模拟 tensordict 的结构。
copy_existing (bool) – 如果为 False（默认），如果 tensordict 中的条目已经是磁盘上存储的张量，并具有关联的文件，但未根据前缀保存在正确的位置，则会引发异常。如果 True，任何现有张量都将复制到新位置。

关键字参数：

num_threads (int, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (bool, 可选) – 如果 True 且 num_threads>0，则该方法将返回 tensordict 的 future。可以使用 future.result() 查询结果 tensordict。
share_non_tensor (bool, 可选) – 如果 True，则非张量数据将在进程之间共享，并且在单个节点内的任何工作程序上进行写入操作（例如就地更新或设置）将更新所有其他工作程序上的值。如果非张量叶节点的数量很高（例如，共享大量非张量数据），这可能会导致 OOM 或类似错误。默认为 False。

然后锁定 TensorDict，这意味着任何非就地的写入操作都将引发异常（例如，重命名、设置或删除条目）。解锁 tensordict 后，内存映射属性将变为 False，因为跨进程身份不再保证。

返回值:: 如果 return_early=False，则为 self，否则为 TensorDictFuture 实例。

注意

以这种方式序列化对于深度嵌套的 tensordict 来说可能很慢，因此不建议在训练循环内调用此方法。

memmap_like(prefix: str | None = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

创建一个与原始 tensordict 形状相同但内容为空的内存映射 tensordict。

参数:

prefix (str) – 内存映射张量将存储的目录前缀。目录树结构将模拟 tensordict 的结构。
copy_existing (bool) – 如果为 False（默认），如果 tensordict 中的条目已经是磁盘上存储的张量，并具有关联的文件，但未根据前缀保存在正确的位置，则会引发异常。如果 True，任何现有张量都将复制到新位置。

关键字参数：

num_threads (int, 可选) – 用于写入内存映射张量的线程数。默认为 0。
return_early (bool, 可选) – 如果 True 且 num_threads>0，则该方法将返回 tensordict 的 future。
share_non_tensor (bool, 可选) – 如果 True，则非张量数据将在进程之间共享，并且在单个节点内的任何工作程序上进行写入操作（例如就地更新或设置）将更新所有其他工作程序上的值。如果非张量叶节点的数量很高（例如，共享大量非张量数据），这可能会导致 OOM 或类似错误。默认为 False。

然后锁定 TensorDict，这意味着任何非就地的写入操作都将引发异常（例如，重命名、设置或删除条目）。解锁 tensordict 后，内存映射属性将变为 False，因为跨进程身份不再保证。

返回值:: 如果 return_early=False，则为一个新的 TensorDict 实例，其数据存储为内存映射张量，否则为 TensorDictFuture 实例。

注意

这是在磁盘上写入一组大型缓冲区的推荐方法，因为 memmap_() 将复制信息，这对于大型内容来说可能很慢。

示例

>>> td = TensorDict({
...     "a": torch.zeros((3, 64, 64), dtype=torch.uint8),
...     "b": torch.zeros(1, dtype=torch.int64),
... }, batch_size=[]).expand(1_000_000)  # expand does not allocate new memory
>>> buffer = td.memmap_like("/path/to/dataset")

memmap_refresh_()¶

如果内存映射 tensordict 具有 saved_path，则刷新其内容。

如果与此 tensordict 没有关联的路径，则此方法将引发异常。

property names: Size¶

检索张量类的维度名称。

返回值:

names (字符串列表)

save(prefix: str | None = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False) → T¶

将张量字典保存到磁盘。

此函数是 memmap() 的代理。

set(key: NestedKey, value: Any, inplace: bool = False, non_blocking: bool = False)¶

设置新的键值对。

参数:

key (str, tuple of str) – 要设置的键的名称。如果为字符串元组，则等效于 getattr 的链式调用，然后是最终的 setattr。
value (Any) – 要存储在 tensorclass 中的值
inplace (bool, optional) – 如果为 True，则 set 将尝试就地更新值。如果为 False 或键不存在，则值将简单地写入其目标位置。

返回值:

self

state_dict(destination=None, prefix='', keep_vars=False, flatten=False) → dict[str, Any]¶: 返回一个 state_dict 字典，该字典可用于保存和加载来自 tensorclass 的数据。

to_tensordict() → TensorDict¶

将 tensorclass 转换为常规 TensorDict。

复制所有条目。内存映射和共享内存张量将转换为常规张量。

返回值:: 一个新的 TensorDict 对象，包含与 tensorclass 相同的值。

unbind(dim: int)¶

返回一个 tensorclass 实例元组，这些实例沿指示的维度解绑。

生成的 tensorclass 实例将共享初始 tensorclass 实例的存储。

RewardData¶

文档

教程

资源