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, generator: torch.Generator | None = None, shared: bool = False, **kwargs)[source]¶

回放缓冲区的集合。

此类允许同时从多个回放缓冲区中读取和采样。它自动组合了存储集合（StorageEnsemble）、写入器（WriterEnsemble）和采样器（SamplerEnsemble）。

注意

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

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

参数：

rbs (ReplayBuffer 实例序列，可选) – 要集合的回放缓冲区。
storages (StorageEnsemble，可选) – 存储集合，如果未传递回放缓冲区。
samplers (SamplerEnsemble，可选) – 采样器集合，如果未传递回放缓冲区。
writers (WriterEnsemble，可选) – 写入器集合，如果未传递回放缓冲区。
transform (Transform，可选) – 如果传递，这将是回放缓冲区集合的变换。每个回放缓冲区的独立变换从其父回放缓冲区中检索，或直接写入 StorageEnsemble 对象中。
batch_size (整数，可选) – 采样时使用的 batch-size。
collate_fn (可调用对象，可选) – 在调用每个独立的 collate_fn 并且数据被放入列表（连同缓冲区 ID）后，用于整理数据（collate）的函数。
collate_fns (可调用对象列表，可选) – 每个嵌套回放缓冲区的 collate_fn。如果未提供，则从 ReplayBuffer 实例中检索。
p (浮点数列表或 Tensor，可选) – 一个浮点数列表，指示每个回放缓冲区的相对权重。如果缓冲区是显式构建的，也可以传递给 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
sample_from_all (布尔值，可选) – 如果 True，将从每个数据集进行采样。这与参数 p 不兼容。默认为 False。如果缓冲区是显式构建的，也可以传递给 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
num_buffer_sampled (整数，可选) – 要采样的缓冲区数量。如果 sample_from_all=True，此参数无效，因为它默认为缓冲区数量。如果 sample_from_all=False，缓冲区将根据概率 p 进行采样。如果缓冲区是显式构建的，也可以传递给 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
generator (torch.Generator，可选) –
用于采样的生成器。为回放缓冲区使用专用的生成器可以实现对种子的精细控制，例如在分布式作业中保持全局种子不同但 RB 种子相同。默认为 None（全局默认生成器）。

警告

目前，生成器对变换无效。
shared (布尔值，可选) – 缓冲区是否使用多进程共享。默认为 False。

示例

>>> 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 (任意类型) – 要添加到回放缓冲区的数据
返回：: 数据在回放缓冲区中的索引。

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

将变换添加到末尾。

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

参数：: transform (Transform) – 要添加的变换
关键字参数：: invert (布尔值，可选) – 如果 True，变换将被反转（写入时调用 forward，读取时调用 inverse）。默认为 False。

Example

>>> 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 或字符串) – 保存回放缓冲区的路径。

示例

>>> 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 (可迭代对象) – 要添加到回放缓冲区的数据集合。
返回：: 添加到回放缓冲区的数据的索引。

警告

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

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

插入变换。

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

参数：

index (整数) – 插入变换的位置。
transform (Transform) – 要添加的变换

关键字参数：

invert (布尔值，可选) – 如果 True，变换将被反转（写入时调用 forward，读取时调用 inverse）。默认为 False。

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

loads(path)¶

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

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

参数：: path (Path 或字符串) – 回放缓冲区保存的路径。

有关更多信息，请参阅 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 (整数，可选) – 要收集的数据大小。如果未提供，此方法将按照采样器指示的 batch-size 进行采样。
return_info (布尔值) – 是否返回信息。如果为 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 (可调用对象，可选) – 如果提供，collate_fn 被设置为此值。否则，它将被重置为默认值。

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

属性 storage¶

回放缓冲区的存储。

存储必须是 Storage 的实例。

属性 write_count¶: 通过 add 和 extend 方法向缓冲区写入的项目总数。

属性 writer¶

回放缓冲区的写入器。

写入器必须是 Writer 的实例。

ReplayBufferEnsemble¶

文档

教程

资源