ReplayBuffer¶

class torchrl.data.ReplayBuffer(*, storage: Storage | None = None, sampler: Sampler | None = None, writer: Writer | 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, checkpointer: 'StorageCheckpointerBase' | None = None, generator: torch.Generator | None = None, shared: bool = False, compilable: bool = None)[source]¶

一個通用的、可組合的回放緩衝區類。

關鍵字引數:

storage (Storage, 可選) – 要使用的儲存。如果未提供，則會建立一個預設的 ListStorage，其 max_size 為 1_000。
sampler (Sampler, 可選) – 要使用的取樣器。如果未提供，則會使用一個預設的 RandomSampler。
writer (Writer, 可選) – 要使用的寫入器。如果未提供，則會使用一個預設的 RoundRobinWriter。
collate_fn (callable, 可選) – 合併樣本列表以形成一個 Tensor(s)/輸出的小批次。用於從 map-style 資料集批次載入時。預設值將根據儲存型別決定。
pin_memory (bool) – 是否應在 rb 樣本上呼叫 pin_memory()。
prefetch (int, 可選) – 使用多執行緒預取下一批次的數量。預設為 None（不預取）。
transform (Transform, 可選) – 呼叫 sample() 時要執行的 Transform。要鏈式使用 transforms，請使用 Compose 類。Transforms 應與 tensordict.TensorDict 內容一起使用。如果回放緩衝區與 PyTree 結構一起使用，也可以傳遞一個泛型可呼叫物件（見下例）。
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)
```
generator (torch.Generator, 可選) –
用於取樣的生成器。為回放緩衝區使用專用生成器可以精細控制種子，例如在分散式作業中保持全域性種子不同但 RB 種子相同。預設為 None（全域性預設生成器）。

警告

截至目前，該生成器對 transforms 無效。
shared (bool, 可選) – 是否使用多程序共享緩衝區。預設為 False。
compilable (bool, 可選) – 寫入器是否可編譯。如果為 True，則寫入器不能在多個程序之間共享。預設為 False。

示例

>>> import torch
>>>
>>> from torchrl.data import ReplayBuffer, ListStorage
>>>
>>> torch.manual_seed(0)
>>> rb = ReplayBuffer(
...     storage=ListStorage(max_size=1000),
...     batch_size=5,
... )
>>> # populate the replay buffer and get the item indices
>>> data = range(10)
>>> indices = rb.extend(data)
>>> # sample will return as many elements as specified in the constructor
>>> sample = rb.sample()
>>> print(sample)
tensor([4, 9, 3, 0, 3])
>>> # Passing the batch-size to the sample method overrides the one in the constructor
>>> sample = rb.sample(batch_size=3)
>>> print(sample)
tensor([9, 7, 3])
>>> # one cans sample using the ``sample`` method or iterate over the buffer
>>> for i, batch in enumerate(rb):
...     print(i, batch)
...     if i == 3:
...         break
0 tensor([7, 3, 1, 6, 6])
1 tensor([9, 8, 6, 6, 8])
2 tensor([4, 3, 6, 9, 1])
3 tensor([4, 4, 1, 9, 9])

回放緩衝區接受任何型別的資料。並非所有儲存型別都有效，因為有些只期望數值資料，但預設的 ListStorage 會。

示例

>>> torch.manual_seed(0)
>>> buffer = ReplayBuffer(storage=ListStorage(100), collate_fn=lambda x: x)
>>> indices = buffer.extend(["a", 1, None])
>>> buffer.sample(3)
[None, 'a', None]

TensorStorage、LazyMemmapStorage 和 LazyTensorStorage 也適用於任何 PyTree 結構（PyTree 是由字典、列表或元組組成的任意深度的巢狀結構，其中葉節點是張量），前提是它只包含張量資料。

示例

>>> from torch.utils._pytree import tree_map
>>> def transform(x):
...     # Zeros all the data in the pytree
...     return tree_map(lambda y: y * 0, x)
>>> rb = ReplayBuffer(storage=LazyMemmapStorage(100), transform=transform)
>>> data = {
...     "a": torch.randn(3),
...     "b": {"c": (torch.zeros(2), [torch.ones(1)])},
...     30: -torch.ones(()),
... }
>>> rb.add(data)
>>> # The sample has a similar structure to the data (with a leading dimension of 10 for each tensor)
>>> s = rb.sample(10)
>>> # let's check that our transform did its job:
>>> def assert0(x):
>>>     assert (x == 0).all()
>>> tree_map(assert0, s)

add(data: Any) → int[source]¶

向回放緩衝區新增單個元素。

引數:: data (Any) – 要新增到回放緩衝區的資料。
返回:: 資料在回放緩衝區中的索引。

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

在末尾追加 transform。

呼叫 sample 時按順序應用 Transforms。

引數:: 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)[source]¶: dumps() 的別名。

dumps(path)[source]¶

將回放緩衝區儲存到指定路徑的磁碟上。

引數:: path (Path or 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()[source]¶: 清空回放緩衝區並將遊標重置為 0。

extend(data: Sequence) → Tensor[source]¶

使用可迭代物件中的一個或多個元素擴充套件回放緩衝區。

如果存在，將呼叫 inverse transforms。`

引數:: data (iterable) – 要新增到回放緩衝區的資料集合。
返回:: 新增到回放緩衝區的資料的索引。

警告

extend() 在處理值列表時可能具有模糊的簽名，可以將其解釋為 PyTree（在這種情況下，列表中的所有元素將被放入儲存中 PyTree 的一個切片中）或要逐個新增的值列表。為了解決這個問題，TorchRL 明確區分了 list 和 tuple：tuple 將被視為 PyTree，而 list（在根級別）將被解釋為要逐個新增到緩衝區的值堆疊。對於 ListStorage 例項，只能提供未繫結的元素（不能是 PyTree）。

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

插入 transform。

呼叫 sample 時按順序執行 Transforms。

引數:

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

關鍵字引數:

invert (bool, 可選) – 如果為 True，則 transform 將被反轉（在寫入期間呼叫 forward，在讀取期間呼叫 inverse）。預設為 False。

load(*args, **kwargs)[source]¶: loads() 的別名。

loads(path)[source]¶

從給定路徑載入回放緩衝區狀態。

緩衝區應具有匹配的元件，並使用 dumps() 儲存。

引數:: path (Path or str) – 回放緩衝區儲存的路徑。

有關更多資訊，請參閱 dumps()。

register_load_hook(hook: Callable[[Any], Any])[source]¶: 為儲存註冊載入鉤子。

注意

鉤子在儲存回放緩衝區時當前不會序列化：它們必須在每次建立緩衝區時手動重新初始化。

register_save_hook(hook: Callable[[Any], Any])[source]¶: 為儲存註冊儲存鉤子。

注意

鉤子在儲存回放緩衝區時當前不會序列化：它們必須在每次建立緩衝區時手動重新初始化。

sample(batch_size: int | None = None, return_info: bool = False) → Any[source]¶

從回放緩衝區中取樣一批資料。

使用 Sampler 取樣索引，並從 Storage 中檢索資料。

引數:

batch_size (int, 可選) – 要收集的資料大小。如果未提供，此方法將按照取樣器指示的批次大小進行取樣。
return_info (bool) – 是否返回資訊。如果為 True，結果是元組 (data, info)。如果為 False，結果是 data。

返回:

在回放緩衝區中選擇的一批資料。如果 return_info 標誌設定為 True，則返回一個包含此批資料和資訊的元組。

屬性 sampler¶

回放緩衝區的取樣器。

取樣器必須是 Sampler 的例項。

save(*args, **kwargs)[source]¶: dumps() 的別名。

set_sampler(sampler: Sampler)[source]¶: 在回放緩衝區中設定一個新的取樣器並返回之前的取樣器。

set_storage(storage: Storage, collate_fn: Callable | None = None)[source]¶

在回放緩衝區中設定一個新的儲存後端，並返回之前的儲存後端。

引數:

storage (Storage) – 緩衝區的新儲存後端。
collate_fn (callable, optional) – 如果提供，則 collate_fn 將被設定為此值。否則它將被重置為預設值。

set_writer(writer: Writer)[source]¶: 在回放緩衝區中設定一個新的寫入器，並返回之前的寫入器。

property storage¶

回放緩衝區的儲存後端。

儲存後端必須是 Storage 的例項。

property write_count¶: 目前透過 add 和 extend 寫入緩衝區的總專案數。

property writer¶

回放緩衝區的寫入器。

寫入器必須是 Writer 的例項。

ReplayBuffer¶

文件

教程

資源