RewardData¶

类 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)[source]¶

属性 batch_size: Size¶

检索张量类的批大小。

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

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

类方法 from_tensordict(tensordict, non_tensordict=None)¶

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

参数：:

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

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

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

参数：:

key (str, tuple of str) – 要查询的键。如果是字符串元组，则等同于链式调用 getattr。
default – 如果在张量类中找不到键，则为默认值。

返回：:

使用输入键存储的值

类方法 load(prefix: str | pathlib.Path, *args, **kwargs) → T¶

从磁盘加载 tensordict。

这个类方法是 load_memmap() 的代理。

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

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

这个类方法是 load_memmap_() 的代理。

类方法 load_memmap(prefix: str | pathlib.Path, device: Optional[device] = None, non_blocking: bool = False, *, out: Optional[TensorDictBase] = 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: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False, existsok: bool = True) → T¶

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

参数：:

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

关键字参数：:

num_threads (int, 可选) – 用于写入 memmap 张量的线程数。默认为 0。
return_early (bool, 可选) – 如果 True 且 num_threads>0，则该方法将返回 tensordict 的 future。
share_non_tensor (bool, 可选) – 如果 True，则非张量数据将在进程之间共享，并且在单个节点内任何 worker 上执行的写入操作（例如就地更新或设置）都将更新所有其他 worker 上的值。如果非张量叶子的数量很高（例如，共享大量非张量数据堆栈），则可能导致 OOM 或类似错误。默认为 False。
existsok (bool, 可选) – 如果 False，则如果张量已存在于同一路径中，将引发异常。默认为 True。

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

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

注意

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

memmap_(prefix: Optional[str] = None, copy_existing: bool = False, *, num_threads: int = 0, return_early: bool = False, share_non_tensor: bool = False, existsok: bool = True) → T¶

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

参数：:

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

关键字参数：:

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

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

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

注意

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

memmap_like(prefix: Optional[str] = None, copy_existing: bool = False, *, existsok: bool = True, 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, 可选) – 用于写入 memmap 张量的线程数。默认为 0。
return_early (bool, 可选) – 如果 True 且 num_threads>0，则该方法将返回 tensordict 的 future。
share_non_tensor (bool, 可选) – 如果 True，则非张量数据将在进程之间共享，并且在单个节点内任何 worker 上执行的写入操作（例如就地更新或设置）都将更新所有其他 worker 上的值。如果非张量叶子的数量很高（例如，共享大量非张量数据堆栈），则可能导致 OOM 或类似错误。默认为 False。
existsok (bool, 可选) – 如果 False，则如果张量已存在于同一路径中，将引发异常。默认为 True。

然后 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，则刷新其内容。

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

属性 names: Size¶

检索张量类的维度名称。

返回：:: 名称（字符串列表）

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

将 tensordict 保存到磁盘。

此函数是 memmap() 的代理。

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

设置新的键值对。

参数：:

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

返回：:

self

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

to_tensordict() → TensorDict¶

将张量类转换为常规 TensorDict。

复制所有条目。Memmap 和共享内存张量被转换为常规张量。

返回：:: 包含与张量类相同值的新 TensorDict 对象。

unbind(dim: int)¶

返回沿指示维度解绑的索引张量类实例的元组。

结果张量类实例将共享初始张量类实例的存储。

RewardData¶

文档

教程

资源