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¶

文件

教程

資源