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)[来源]¶

多个回放缓冲区的一个集合。

此类允许一次性读取和采样多个回放缓冲区。它会自动组合存储（StorageEnsemble）、写入器（WriterEnsemble）和采样器（SamplerEnsemble）的集合。

注意

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

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

参数:

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

警告

目前，生成器对变换没有影响。
shared (bool, optional) – 缓冲区是否将使用多进程共享。默认为 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 (Any) – 要添加到重放缓冲区的数据
返回:: 数据在重放缓冲区中的索引。

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

将变换附加到末尾。

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

参数:: transform (Transform) – 要附加的变换
关键字参数:: invert (bool, optional) – 如果为 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()

classmethod as_remote(remote_config=None)¶

创建一个远程 ray 类的实例。

参数:

cls (Python Class) – 要远程实例化的类。
remote_config (dict) – 为该类保留的 CPU 核心数量。默认为 torchrl.collectors.distributed.ray.DEFAULT_REMOTE_CLASS_CONFIG。

返回:

一个创建 ray 远程类实例的函数。

property batch_size¶

重放缓冲区的批次大小。

批次大小可以通过在 sample() 方法中设置 batch_size 参数来覆盖。

它定义了 sample() 返回的样本数量，以及 ReplayBuffer 迭代器产生的样本数量。

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(empty_write_count: bool = True)¶

清空重放缓冲区并将游标重置为 0。

参数:: empty_write_count (bool, optional) – 是否清空 write_count 属性。默认为 True。

extend(data: Sequence, *, update_priority: bool | None = None) → torch.Tensor¶

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

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

参数:: data (iterable) – 要添加到经验回放缓冲区的元素集合。
关键字参数:: update_priority (bool, optional) – 是否更新数据的优先级。默认为 True。在此类中无效。有关更多详细信息，请参阅 extend()。
返回:: 添加到经验回放缓冲区的数据的索引。

警告

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

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

插入变换。

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

参数:

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

关键字参数:

invert (bool, optional) – 如果为 True，则在写入时调用变换的向前调用，在读取时调用反向调用。默认为 False。

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

loads(path)¶

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

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

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

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

next()¶

返回重放缓冲区的下一个项。

此方法用于在 __iter__ 不可用的情况下迭代重放缓冲区，例如 RayReplayBuffer。

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, optional) – 要收集的数据的大小。如果未提供，此方法将采样由采样器指示的批次大小。
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 write_count¶: 通过 add 和 extend 写入缓冲区的总项数。

property writer¶

重放缓冲区的写入器。

写入器必须是 Writer 的实例。

ReplayBufferEnsemble¶

文档

教程

资源