ReplayBuffer¶

class torchrl.data.ReplayBuffer(*, storage: Storage | None = None, sampler: Sampler | None = None, writer: Writer | None = None, collate_fn: Callable | None = None, pin_memory: bool = False, prefetch: int | None = None, transform: 'Transform' | None = None, batch_size: int | None = None, dim_extend: int | None = None, checkpointer: 'StorageCheckpointerBase' | None = None, generator: torch.Generator | None = None, shared: bool = False, compilable: bool = None)[source]¶

一个通用的、可组合的回放缓冲区类。

关键字参数:

storage (Storage, 可选) – 要使用的存储。如果未提供，则会创建一个默认的 ListStorage，其 max_size 为 1_000。
sampler (Sampler, 可选) – 要使用的采样器。如果未提供，则会使用一个默认的 RandomSampler。
writer (Writer, 可选) – 要使用的写入器。如果未提供，则会使用一个默认的 RoundRobinWriter。
collate_fn (callable, 可选) – 合并样本列表以形成一个 Tensor(s)/输出的小批量。用于从 map-style 数据集批量加载时。默认值将根据存储类型决定。
pin_memory (bool) – 是否应在 rb 样本上调用 pin_memory()。
prefetch (int, 可选) – 使用多线程预取下一批次的数量。默认为 None（不预取）。
transform (Transform, 可选) – 调用 sample() 时要执行的 Transform。要链式使用 transforms，请使用 Compose 类。Transforms 应与 tensordict.TensorDict 内容一起使用。如果回放缓冲区与 PyTree 结构一起使用，也可以传递一个泛型可调用对象（见下例）。
batch_size (int, 可选) –
调用 sample() 时要使用的批量大小。

注意

批量大小可以在构建时通过 batch_size 参数指定，或者在采样时指定。当前者在实验过程中批量大小一致时应优先选择。如果批量大小可能发生变化，可以将其传递给 sample() 方法。此选项与预取（因为它需要提前知道批量大小）以及具有 drop_last 参数的采样器不兼容。
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)
```
generator (torch.Generator, 可选) –
用于采样的生成器。为回放缓冲区使用专用生成器可以精细控制种子，例如在分布式作业中保持全局种子不同但 RB 种子相同。默认为 None（全局默认生成器）。

警告

截至目前，该生成器对 transforms 无效。
shared (bool, 可选) – 是否使用多进程共享缓冲区。默认为 False。
compilable (bool, 可选) – 写入器是否可编译。如果为 True，则写入器不能在多个进程之间共享。默认为 False。

示例

>>> import torch
>>>
>>> from torchrl.data import ReplayBuffer, ListStorage
>>>
>>> torch.manual_seed(0)
>>> rb = ReplayBuffer(
...     storage=ListStorage(max_size=1000),
...     batch_size=5,
... )
>>> # populate the replay buffer and get the item indices
>>> data = range(10)
>>> indices = rb.extend(data)
>>> # sample will return as many elements as specified in the constructor
>>> sample = rb.sample()
>>> print(sample)
tensor([4, 9, 3, 0, 3])
>>> # Passing the batch-size to the sample method overrides the one in the constructor
>>> sample = rb.sample(batch_size=3)
>>> print(sample)
tensor([9, 7, 3])
>>> # one cans sample using the ``sample`` method or iterate over the buffer
>>> for i, batch in enumerate(rb):
...     print(i, batch)
...     if i == 3:
...         break
0 tensor([7, 3, 1, 6, 6])
1 tensor([9, 8, 6, 6, 8])
2 tensor([4, 3, 6, 9, 1])
3 tensor([4, 4, 1, 9, 9])

回放缓冲区接受任何类型的数据。并非所有存储类型都有效，因为有些只期望数值数据，但默认的 ListStorage 会。

示例

>>> torch.manual_seed(0)
>>> buffer = ReplayBuffer(storage=ListStorage(100), collate_fn=lambda x: x)
>>> indices = buffer.extend(["a", 1, None])
>>> buffer.sample(3)
[None, 'a', None]

TensorStorage、LazyMemmapStorage 和 LazyTensorStorage 也适用于任何 PyTree 结构（PyTree 是由字典、列表或元组组成的任意深度的嵌套结构，其中叶节点是张量），前提是它只包含张量数据。

示例

>>> from torch.utils._pytree import tree_map
>>> def transform(x):
...     # Zeros all the data in the pytree
...     return tree_map(lambda y: y * 0, x)
>>> rb = ReplayBuffer(storage=LazyMemmapStorage(100), transform=transform)
>>> data = {
...     "a": torch.randn(3),
...     "b": {"c": (torch.zeros(2), [torch.ones(1)])},
...     30: -torch.ones(()),
... }
>>> rb.add(data)
>>> # The sample has a similar structure to the data (with a leading dimension of 10 for each tensor)
>>> s = rb.sample(10)
>>> # let's check that our transform did its job:
>>> def assert0(x):
>>>     assert (x == 0).all()
>>> tree_map(assert0, s)

add(data: Any) → int[source]¶

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

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

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

在末尾追加 transform。

调用 sample 时按顺序应用 Transforms。

参数:: transform (Transform) – 要追加的 transform。
关键字参数:: invert (bool, 可选) – 如果为 True，则 transform 将被反转（在写入期间调用 forward，在读取期间调用 inverse）。默认为 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)[source]¶: dumps() 的别名。

dumps(path)[source]¶

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

参数:: path (Path or 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()[source]¶: 清空回放缓冲区并将游标重置为 0。

extend(data: Sequence) → Tensor[source]¶

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

如果存在，将调用 inverse transforms。`

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

警告

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

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

插入 transform。

调用 sample 时按顺序执行 Transforms。

参数:

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

关键字参数:

invert (bool, 可选) – 如果为 True，则 transform 将被反转（在写入期间调用 forward，在读取期间调用 inverse）。默认为 False。

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

loads(path)[source]¶

从给定路径加载回放缓冲区状态。

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

参数:: path (Path or str) – 回放缓冲区保存的路径。

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

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

注意

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

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

注意

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

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

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

使用 Sampler 采样索引，并从 Storage 中检索数据。

参数:

batch_size (int, 可选) – 要收集的数据大小。如果未提供，此方法将按照采样器指示的批量大小进行采样。
return_info (bool) – 是否返回信息。如果为 True，结果是元组 (data, info)。如果为 False，结果是 data。

返回:

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

属性 sampler¶

回放缓冲区的采样器。

采样器必须是 Sampler 的实例。

save(*args, **kwargs)[source]¶: dumps() 的别名。

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

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

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

参数:

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

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

property storage¶

回放缓冲区的存储后端。

存储后端必须是 Storage 的实例。

property write_count¶: 目前通过 add 和 extend 写入缓冲区的总项目数。

property writer¶

回放缓冲区的写入器。

写入器必须是 Writer 的实例。

ReplayBuffer¶

文档

教程

资源