快捷方式

TensorDictReplayBuffer

class torchrl.data.TensorDictReplayBuffer(*, priority_key: str = 'td_error', **kwargs)[source]

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

关键字参数:
  • storage (Storage, 可选) – 要使用的存储。如果未提供,将创建一个默认的 ListStorage,其 max_size1_000

  • sampler (Sampler, 可选) – 要使用的采样器。如果未提供,将使用默认的 RandomSampler()。

  • writer (Writer, 可选) – 要使用的写入器。如果未提供,将使用默认的 RoundRobinWriter

  • collate_fn (callable, 可选) – 合并样本列表以形成一个 Tensor(s)/输出的 mini-batch。在从映射式数据集批量加载时使用。默认值将根据存储类型确定。

  • pin_memory (bool) – 是否应对回放缓冲区样本调用 pin_memory()。

  • prefetch (int, 可选) – 使用多线程预取的下一个批次的数量。默认为 None(不进行预取)。

  • transform (Transform, 可选) – 调用 sample() 时要执行的转换。要链式调用转换,请使用 Compose 类。转换应与 tensordict.TensorDict 内容一起使用。如果与其他结构一起使用,则转换应使用前导键 "data" 进行编码,该键将用于从非 TensorDict 内容构建 TensorDict。

  • batch_size (int, 可选) –

    调用 sample() 时要使用的批次大小。

    注意

    批次大小可以在构造时通过 batch_size 参数指定,也可以在采样时指定。当批次大小在整个实验中保持一致时,应首选前者。如果批次大小可能更改,可以将其传递给 sample() 方法。此选项与预取不兼容(因为这需要提前知道批次大小),也与具有 drop_last 参数的采样器不兼容。

  • priority_key (str, 可选) – 在添加到此 ReplayBuffer 的 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)
    

  • generator (torch.Generator, 可选) –

    用于采样的生成器。为回放缓冲区使用专用的生成器可以实现对种子的精细控制,例如在分布式作业中保持全局种子不同但回放缓冲区种子相同。默认为 None(全局默认生成器)。

    警告

    截至目前,该生成器对 transforms 没有影响。

  • shared (bool, 可选) – 是否使用多进程共享缓冲区。默认为 False

  • compilable (bool, 可选) – 写入器是否可编译。如果为 True,则写入器不能在多个进程之间共享。默认为 False

示例

>>> 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[source]

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

参数:

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 (Pathstr) – 保存回放缓冲区的路径。

示例

>>> 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 (Pathstr) – 回放缓冲区保存的路径。

更多信息请参见 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, 可选) – 要收集的数据大小。如果未提供,此方法将按照采样器指示的批次大小进行采样。

  • return_info (bool) – 是否返回信息。如果为 True,结果是一个元组 (data, info)。如果为 False,结果是数据。

返回:

一个 TensorDict,包含从回放缓冲区中选定的批量数据。如果设置了 return_info 标志,则返回包含该 TensorDict 和 info 的元组。

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, 可选) – 如果提供,collate_fn 将设置为此值。否则,它将重置为默认值。

set_writer(writer: Writer)

在回放缓冲区中设置一个新的写入器并返回先前的写入器。

property storage

回放缓冲区的存储。

存储必须是 Storage 的实例。

property write_count

通过 add 和 extend 方法到目前为止写入缓冲区的总条目数。

property writer

回放缓冲区的写入器。

写入器必须是 Writer 的实例。

文档

访问全面的 PyTorch 开发者文档

查看文档

教程

获取面向初学者和高级开发者的深度教程

查看教程

资源

查找开发资源并获得问题解答

查看资源