ReplayBufferEnsemble¶

class torchrl.data.replay_buffers.ReplayBufferEnsemble(*rbs, storages: StorageEnsemble | None = None, samplers: SamplerEnsemble | None = None, writers: WriterEnsemble | None = None, transform: 'Transform' | None = None, batch_size: int | None = None, collate_fn: Callable | None = None, collate_fns: List[Callable] | None = None, p: Tensor = None, sample_from_all: bool = False, num_buffer_sampled: int | None = None, **kwargs)[source]¶

回放缓冲区的集合。

此类允许同时从多个回放缓冲区读取和采样。它会自动组合存储的集合 (StorageEnsemble)、写入器 (WriterEnsemble) 和采样器 (SamplerEnsemble).

注意

禁止直接写入此类，但可以索引以检索嵌套缓冲区并扩展它。

构建 ReplayBufferEnsemble 有两种截然不同的方法：可以传递一个回放缓冲区列表，也可以直接传递组件（存储、写入器和采样器），就像对其他回放缓冲区子类一样。

参数：

rbs (ReplayBuffer 实例的序列, 可选) – 要组合的回放缓冲区。
storages (StorageEnsemble, 可选) – 存储的集合，如果没有传递回放缓冲区。
samplers (SamplerEnsemble, 可选) – 采样器的集合，如果没有传递回放缓冲区。
writers (WriterEnsemble, 可选) – 写入器的集合，如果没有传递回放缓冲区。
transform (Transform, 可选) – 如果传递，这将是回放缓冲区集合的转换。每个回放缓冲区的单独转换是从其父回放缓冲区检索的，或者直接写入 StorageEnsemble 对象。
batch_size (int, 可选) – 采样期间使用的批次大小。
collate_fn (可调用, 可选) – 用于在调用每个单独的 collate_fn 并将数据放入列表（以及缓冲区 ID）后整理数据的函数。
collate_fns (可调用列表, 可选) – 每个嵌套回放缓冲区的 collate_fn。如果未提供，则从 ReplayBuffer 实例中检索。
p (浮点数列表 或张量, 可选) – 一个浮点数列表，指示每个回放缓冲区的相对权重。如果显式构建缓冲区，也可以传递到 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
sample_from_all (bool, 可选) – 如果 True，将从每个数据集进行采样。这与 p 参数不兼容。默认值为 False。如果明确构建了缓冲区，也可以传递给 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
num_buffer_sampled (int, 可选) – 要采样的缓冲区数量。如果 sample_from_all=True，则此参数无效，因为它默认为缓冲区数量。如果 sample_from_all=False，将根据概率 p 对缓冲区进行采样。如果明确构建了缓冲区，也可以传递给 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。

示例

>>> from torchrl.envs import Compose, ToTensorImage, Resize, RenameTransform
>>> from torchrl.data import TensorDictReplayBuffer, ReplayBufferEnsemble, LazyMemmapStorage
>>> from tensordict import TensorDict
>>> import torch
>>> rb0 = TensorDictReplayBuffer(
...     storage=LazyMemmapStorage(10),
...     transform=Compose(
...         ToTensorImage(in_keys=["pixels", ("next", "pixels")]),
...         Resize(32, in_keys=["pixels", ("next", "pixels")]),
...         RenameTransform([("some", "key")], ["renamed"]),
...     ),
... )
>>> rb1 = TensorDictReplayBuffer(
...     storage=LazyMemmapStorage(10),
...     transform=Compose(
...         ToTensorImage(in_keys=["pixels", ("next", "pixels")]),
...         Resize(32, in_keys=["pixels", ("next", "pixels")]),
...         RenameTransform(["another_key"], ["renamed"]),
...     ),
... )
>>> rb = ReplayBufferEnsemble(
...     rb0,
...     rb1,
...     p=[0.5, 0.5],
...     transform=Resize(33, in_keys=["pixels"], out_keys=["pixels33"]),
... )
>>> print(rb)
ReplayBufferEnsemble(
    storages=StorageEnsemble(
        storages=(<torchrl.data.replay_buffers.storages.LazyMemmapStorage object at 0x13a2ef430>, <torchrl.data.replay_buffers.storages.LazyMemmapStorage object at 0x13a2f9310>),
        transforms=[Compose(
                ToTensorImage(keys=['pixels', ('next', 'pixels')]),
                Resize(w=32, h=32, interpolation=InterpolationMode.BILINEAR, keys=['pixels', ('next', 'pixels')]),
                RenameTransform(keys=[('some', 'key')])), Compose(
                ToTensorImage(keys=['pixels', ('next', 'pixels')]),
                Resize(w=32, h=32, interpolation=InterpolationMode.BILINEAR, keys=['pixels', ('next', 'pixels')]),
                RenameTransform(keys=['another_key']))]),
    samplers=SamplerEnsemble(
        samplers=(<torchrl.data.replay_buffers.samplers.RandomSampler object at 0x13a2f9220>, <torchrl.data.replay_buffers.samplers.RandomSampler object at 0x13a2f9f70>)),
    writers=WriterEnsemble(
        writers=(<torchrl.data.replay_buffers.writers.TensorDictRoundRobinWriter object at 0x13a2d9b50>, <torchrl.data.replay_buffers.writers.TensorDictRoundRobinWriter object at 0x13a2f95b0>)),
batch_size=None,
transform=Compose(
        Resize(w=33, h=33, interpolation=InterpolationMode.BILINEAR, keys=['pixels'])),
collate_fn=<built-in method stack of type object at 0x128648260>)
>>> data0 = TensorDict(
...     {
...         "pixels": torch.randint(255, (10, 244, 244, 3)),
...         ("next", "pixels"): torch.randint(255, (10, 244, 244, 3)),
...         ("some", "key"): torch.randn(10),
...     },
...     batch_size=[10],
... )
>>> data1 = TensorDict(
...     {
...         "pixels": torch.randint(255, (10, 64, 64, 3)),
...         ("next", "pixels"): torch.randint(255, (10, 64, 64, 3)),
...         "another_key": torch.randn(10),
...     },
...     batch_size=[10],
... )
>>> rb[0].extend(data0)
>>> rb[1].extend(data1)
>>> for _ in range(2):
...     sample = rb.sample(10)
...     assert sample["next", "pixels"].shape == torch.Size([2, 5, 3, 32, 32])
...     assert sample["pixels"].shape == torch.Size([2, 5, 3, 32, 32])
...     assert sample["pixels33"].shape == torch.Size([2, 5, 3, 33, 33])
...     assert sample["renamed"].shape == torch.Size([2, 5])

add(data: Any) → 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(data: Sequence) → Tensor¶

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

如果存在，将调用逆转换。`

参数：: 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) → Any¶

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

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

参数：

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

返回值:

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

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 的实例。

ReplayBufferEnsemble¶

文档

教程

资源