TensorDictReplayBuffer¶

class torchrl.data.TensorDictReplayBuffer(*, priority_key: str = 'td_error', **kwargs)[源代码]¶

围绕 ReplayBuffer 类构建的特定于 TensorDict 的包装器。

关键字参数：

storage (Storage, 可选) – 要使用的存储。如果未提供，则会创建一个具有 max_size 为 1_000 的默认 ListStorage。
sampler (Sampler, 可选) – 要使用的采样器。如果未提供，则会使用默认的 RandomSampler()。
writer (Writer, 可选) – 要使用的写入器。如果未提供，则会使用默认的 RoundRobinWriter。
collate_fn (可调用, 可选) – 将样本列表合并以形成 Tensor(s)/输出的小批量。在从映射样式数据集进行批量加载时使用。默认值将根据存储类型决定。
pin_memory (bool) – 是否应在 rb 样本上调用 pin_memory()。
prefetch (int, 可选) – 使用多线程预取下一个批次的次数。默认为 None（不预取）。
transform (Transform, 可选) – 在调用 sample() 时执行的转换。要链接转换，请使用 Compose 类。转换应与 tensordict.TensorDict 内容一起使用。如果与其他结构一起使用，则转换应使用将在从非 tensordict 内容构建 tensordict 时使用的 "data" 前导键进行编码。

batch_size (int, 可选) –

在调用 sample() 时使用的批次大小。 .. 注意

The batch-size can be specified at construction time via the
``batch_size`` argument, or at sampling time. The former should
be preferred whenever the batch-size is consistent across the
experiment. If the batch-size is likely to change, it can be
passed to the :meth:`~.sample` method. This option is
incompatible with prefetching (since this requires to know the
batch-size in advance) as well as with samplers that have a
``drop_last`` argument.

priority_key (str, 可选) – 假定在添加到此回放缓冲区的 TensorDict 中存储优先级的键。当采样器为 PrioritizedSampler 类型时，应使用此参数。默认为 "td_error"。
dim_extend (int, 可选) –
在调用 extend() 时，表示要考虑扩展的维度。默认为 storage.ndim-1。当使用 dim_extend > 0 时，建议在存储实例化时使用 ndim 参数（如果该参数可用），以便让存储知道数据是多维的，并在采样过程中保持存储容量和批次大小的一致概念。
注意

此参数对 add() 没有影响，因此在代码库中同时使用 add() 和 extend() 时应谨慎使用。例如
```
>>> data = torch.zeros(3, 4)
>>> rb = ReplayBuffer(
...     storage=LazyTensorStorage(10, ndim=2),
...     dim_extend=1)
>>> # these two approaches are equivalent:
>>> for d in data.unbind(1):
...     rb.add(d)
>>> rb.extend(data)
```

示例

>>> import torch
>>>
>>> from torchrl.data import LazyTensorStorage, TensorDictReplayBuffer
>>> from tensordict import TensorDict
>>>
>>> torch.manual_seed(0)
>>>
>>> rb = TensorDictReplayBuffer(storage=LazyTensorStorage(10), batch_size=5)
>>> data = TensorDict({"a": torch.ones(10, 3), ("b", "c"): torch.zeros(10, 1, 1)}, [10])
>>> rb.extend(data)
>>> sample = rb.sample(3)
>>> # samples keep track of the index
>>> print(sample)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([3, 1, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3]),
            device=cpu,
            is_shared=False),
        index: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.int32, is_shared=False)},
    batch_size=torch.Size([3]),
    device=cpu,
    is_shared=False)
>>> # we can iterate over the buffer
>>> for i, data in enumerate(rb):
...     print(i, data)
...     if i == 2:
...         break
0 TensorDict(
    fields={
        a: Tensor(shape=torch.Size([5, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([5, 1, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([5]),
            device=cpu,
            is_shared=False),
        index: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int32, is_shared=False)},
    batch_size=torch.Size([5]),
    device=cpu,
    is_shared=False)
1 TensorDict(
    fields={
        a: Tensor(shape=torch.Size([5, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([5, 1, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([5]),
            device=cpu,
            is_shared=False),
        index: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int32, is_shared=False)},
    batch_size=torch.Size([5]),
    device=cpu,
    is_shared=False)

add(data: TensorDictBase) → int[源代码]¶

将单个元素添加到回放缓冲区。

参数：: data (Any) – 要添加到回放缓冲区的数据
返回值：: 数据在回放缓冲区中的索引。

append_transform(transform: Transform, *, invert: bool = False) → ReplayBuffer¶

在末尾追加转换。

在调用 sample 时，转换按顺序应用。

参数：: transform (Transform) – 要追加的转换
关键字参数：: invert (bool, 可选) – 如果为 True，则转换将被反转（在写入时调用正向调用，在读取时调用逆向调用）。默认为 False。

示例

>>> rb = ReplayBuffer(storage=LazyMemmapStorage(10), batch_size=4)
>>> data = TensorDict({"a": torch.zeros(10)}, [10])
>>> def t(data):
...     data += 1
...     return data
>>> rb.append_transform(t, invert=True)
>>> rb.extend(data)
>>> assert (data == 1).all()

dump(*args, **kwargs)¶: 是 dumps() 的别名。

dumps(path)¶

将重放缓冲区保存到指定路径的磁盘上。

参数：: path (Path 或 str) – 保存重放缓冲区的路径。

示例

>>> import tempfile
>>> import tqdm
>>> from torchrl.data import LazyMemmapStorage, TensorDictReplayBuffer
>>> from torchrl.data.replay_buffers.samplers import PrioritizedSampler, RandomSampler
>>> import torch
>>> from tensordict import TensorDict
>>> # Build and populate the replay buffer
>>> S = 1_000_000
>>> sampler = PrioritizedSampler(S, 1.1, 1.0)
>>> # sampler = RandomSampler()
>>> storage = LazyMemmapStorage(S)
>>> rb = TensorDictReplayBuffer(storage=storage, sampler=sampler)
>>>
>>> for _ in tqdm.tqdm(range(100)):
...     td = TensorDict({"obs": torch.randn(100, 3, 4), "next": {"obs": torch.randn(100, 3, 4)}, "td_error": torch.rand(100)}, [100])
...     rb.extend(td)
...     sample = rb.sample(32)
...     rb.update_tensordict_priority(sample)
>>> # save and load the buffer
>>> with tempfile.TemporaryDirectory() as tmpdir:
...     rb.dumps(tmpdir)
...
...     sampler = PrioritizedSampler(S, 1.1, 1.0)
...     # sampler = RandomSampler()
...     storage = LazyMemmapStorage(S)
...     rb_load = TensorDictReplayBuffer(storage=storage, sampler=sampler)
...     rb_load.loads(tmpdir)
...     assert len(rb) == len(rb_load)

empty()¶: 清空重放缓冲区并将游标重置为 0。

extend(tensordicts: TensorDictBase) → Tensor[source]¶

使用可迭代对象中的一个或多个元素扩展重放缓冲区。

如果存在，则将调用反向转换。`

参数：: data (iterable) – 要添加到重放缓冲区的数据集合。
返回值：: 添加到重放缓冲区的数据的索引。

警告

extend() 在处理值列表时可能具有模棱两可的签名，这些值列表应该被解释为 PyTree（在这种情况下，列表中的所有元素都将被放入存储中存储的 PyTree 中的一个切片）或要添加的值列表。为解决这个问题，TorchRL 对列表和元组做出了明确的区分：元组将被视为 PyTree，列表（在根级别）将被解释为要逐个添加到缓冲区的堆叠值。对于 ListStorage 实例，只能提供未绑定的元素（没有 PyTree）。

insert_transform(index: int, transform: Transform, *, invert: bool = False) → ReplayBuffer¶

插入变换。

当调用 sample 时，变换按顺序执行。

参数：

index (int) – 插入变换的位置。
transform (Transform) – 要追加的转换

关键字参数：

invert (bool, 可选) – 如果为 True，则转换将被反转（在写入时调用正向调用，在读取时调用逆向调用）。默认为 False。

load(*args, **kwargs)¶: loads() 的别名。

loads(path)¶

在给定路径加载重放缓冲区状态。

缓冲区应具有匹配的组件，并使用 dumps() 保存。

参数：: path (Path 或 str) – 保存重放缓冲区的路径。

有关更多信息，请参见 dumps()。

register_load_hook(hook: Callable[[Any], Any])¶: 为存储注册一个加载钩子。

注意

钩子目前在保存重放缓冲区时不会被序列化：每次创建缓冲区时，必须手动重新初始化它们。

register_save_hook(hook: Callable[[Any], Any])¶: 为存储注册一个保存钩子。

注意

钩子目前在保存重放缓冲区时不会被序列化：每次创建缓冲区时，必须手动重新初始化它们。

sample(batch_size: int | None = None, return_info: bool = False, include_info: bool = None) → TensorDictBase[source]¶

从重放缓冲区中采样一批数据。

使用 Sampler 采样索引，并从 Storage 中检索它们。

参数：

batch_size (int, optional) – 要收集的数据的大小。如果未提供，此方法将根据采样器采样批次大小。
return_info (bool) – 是否返回信息。如果为 True，则结果为元组 (data, info)。如果为 False，则结果为数据。

返回值：

包含在重放缓冲区中选择的批次数据的 tensordict。如果 return_info 标志设置为 True，则包含此 tensordict 和信息的元组。

property sampler¶

重放缓冲区的采样器。

采样器必须是 Sampler 的实例。

save(*args, **kwargs)¶: 是 dumps() 的别名。

set_sampler(sampler: Sampler)¶: 在重放缓冲区中设置一个新的采样器并返回之前的采样器。

set_storage(storage: Storage, collate_fn: Callable | None = None)¶

在重放缓冲区中设置一个新的存储并返回之前的存储。

参数：

storage (Storage) – 缓冲区的新存储。
collate_fn (callable, optional) – 如果提供，则 collate_fn 设置为此值。否则将其重置为默认值。

set_writer(writer: Writer)¶: 在重放缓冲区中设置一个新的写入器并返回之前的写入器。

property storage¶

重放缓冲区的存储。

存储必须是 Storage 的实例。

property writer¶

重放缓冲区的写入器。

编写器必须是 Writer 的实例。

TensorDictReplayBuffer¶

文档

教程

资源