PrioritizedReplayBuffer¶

class torchrl.data.PrioritizedReplayBuffer(*, alpha: float, beta: float, eps: float = 1e-08, dtype: torch.dtype = torch.float32, storage: Storage | 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)[源代码]¶

优先经验重放缓冲区。

所有参数均为仅关键字参数。

介绍自 Schaul, T.; Quan, J.; Antonoglou, I.; and Silver, D. 2015. Prioritized experience replay. (https://arxiv.org/abs/1511.05952)

参数:

alpha (float) – 指数 α 决定了优先级的程度，α = 0 对应于均匀情况。
beta (float) – 重要性采样的负指数。
eps (float) – 添加到优先级中的 delta 值，确保缓冲区不包含空优先级。
storage (Storage, 可选) – 要使用的存储。如果未提供，则会创建一个默认的 ListStorage，其 max_size 为 1_000。
collate_fn (可调用对象, 可选) – 合并样本列表以形成 Tensor(s)/输出的 mini-batch。在使用基于映射风格数据集进行批加载时使用。默认值将根据存储类型确定。
pin_memory (bool) – 是否应在 rb 样本上调用 pin_memory()。
prefetch (int, 可选) – 使用多线程预取下一批次的数量。默认为 None (不进行预取)。
transform (Transform, 可选) – 当调用 sample() 时执行的 Transform。要链式使用 transform，请使用 Compose 类。Transform 应该用于 tensordict.TensorDict 内容。如果用于其他结构，transform 应该以 "data" 为前导键进行编码，该键将用于从非 tensordict 内容构建 tensordict。
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)
```

注意

通用优先重放缓冲区（即非 tensordict 支持的）需要调用 sample() 并将 return_info 参数设置为 True 才能访问索引，进而更新优先级。使用 tensordict.TensorDict 和相关的 TensorDictPrioritizedReplayBuffer 简化了此过程。

示例

>>> import torch
>>>
>>> from torchrl.data import ListStorage, PrioritizedReplayBuffer
>>>
>>> torch.manual_seed(0)
>>>
>>> rb = PrioritizedReplayBuffer(alpha=0.7, beta=0.9, storage=ListStorage(10))
>>> data = range(10)
>>> rb.extend(data)
>>> sample = rb.sample(3)
>>> print(sample)
tensor([1, 0, 1])
>>> # get the info to find what the indices are
>>> sample, info = rb.sample(5, return_info=True)
>>> print(sample, info)
tensor([2, 7, 4, 3, 5]) {'_weight': array([1., 1., 1., 1., 1.], dtype=float32), 'index': array([2, 7, 4, 3, 5])}
>>> # update priority
>>> priority = torch.ones(5) * 5
>>> rb.update_priority(info["index"], priority)
>>> # and now a new sample, the weights should be updated
>>> sample, info = rb.sample(5, return_info=True)
>>> print(sample, info)
tensor([2, 5, 2, 2, 5]) {'_weight': array([0.36278465, 0.36278465, 0.36278465, 0.36278465, 0.36278465],
      dtype=float32), 'index': array([2, 5, 2, 2, 5])}

add(data: Any) → int¶

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

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

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

在末尾追加 transform。

调用 sample 时按顺序应用 transform。

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

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

如果存在，将调用 inverse transform。

参数:: data (可迭代对象) – 要添加到重放缓冲区的数据集合。
返回:: 添加到重放缓冲区的数据的索引。

警告

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

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

插入 transform。

调用 sample 时按顺序执行 transform。

参数:

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

关键字参数:

invert (bool, 可选) – 如果为 True，则 transform 将被反转（写入时调用 forward，读取时调用 inverse）。默认为 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，结果是 tuple (data, info)。如果为 False，结果是数据。

返回:

从重放缓冲区中选定的批量数据。如果 return_info 标志设置为 True，则返回包含此批量数据和信息的 tuple。

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)¶: 在重放缓冲区中设置新的 writer 并返回先前的 writer。

property storage¶

重放缓冲区的存储。

存储必须是 Storage 的实例。

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

property writer¶

重放缓冲区的 writer。

写入器必须是 Writer 的实例。

PrioritizedReplayBuffer¶

文档

教程

资源