TensorDictPrioritizedReplayBuffer¶

class torchrl.data.TensorDictPrioritizedReplayBuffer(*, alpha: float, beta: float, priority_key: str = 'td_error', eps: float = 1e-08, storage: Storage | None = None, collate_fn: Callable | None = None, pin_memory: bool = False, prefetch: int | None = None, transform: 'Transform' | None = None, reduction: str = 'max', batch_size: int | None = None, dim_extend: int | None = None, generator: torch.Generator | None = None, shared: bool = False, compilable: bool = False)[source]¶

圍繞 PrioritizedReplayBuffer 類的 TensorDict 特定包裝器。

此類返回帶有新鍵 "index" 的 tensordict，該鍵表示經驗回放緩衝區中每個元素的索引。它還提供了 update_tensordict_priority() 方法，該方法只需將 tensordict 及其新優先順序值傳遞給它即可。

關鍵字引數:

alpha (float) – 指數 α 決定了優先順序的程度，當 α = 0 時對應於均勻分佈的情況。
beta (float) – 重要性取樣負指數。
eps (float) – 新增到優先順序中的 delta 值，用於確保緩衝區不包含零優先順序。
storage (Storage, optional) – 要使用的儲存。如果未提供，將建立一個預設的 ListStorage，其 max_size 為 1_000。
collate_fn (callable, optional) – 將樣本列表合併以形成 Tensor(s)/輸出的小批次。在從 map-style 資料集進行批次載入時使用。預設值將根據儲存型別決定。
pin_memory (bool) – 是否應對 rb 樣本呼叫 pin_memory()。
prefetch (int, optional) – 使用多執行緒預取下一批次的數量。預設為 None（不進行預取）。
transform (Transform, optional) – 當呼叫 sample() 時要執行的 Transform。要鏈式呼叫 transforms，請使用 Compose 類。Transforms 應與 tensordict.TensorDict 內容一起使用。如果與其他結構一起使用，transforms 應編碼一個 "data" 開頭鍵，該鍵將用於從非 tensordict 內容構造 tensordict。
batch_size (int, optional) –
呼叫 sample() 時要使用的批次大小。

注意

批次大小可以在構造時透過 batch_size 引數指定，也可以在取樣時指定。如果實驗中的批次大小一致，應優先使用前者。如果批次大小可能改變，可以將其傳遞給 sample() 方法。此選項與預取不相容（因為它需要提前知道批次大小），也與帶有 drop_last 引數的取樣器不相容。
priority_key (str, optional) – 優先順序被假定儲存在此 ReplayBuffer 中新增的 TensorDicts 的鍵。當取樣器型別為 PrioritizedSampler 時使用此鍵。預設為 "td_error"。
reduction (str, optional) – 多維 tensordicts（即儲存的軌跡）的歸約方法。可以是“max”、“min”、“median”或“mean”之一。
dim_extend (int, optional) –
表示呼叫 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, optional) –
用於取樣的生成器。為經驗回放緩衝區使用專用生成器可以實現對種子進行精細控制，例如在分散式作業中保持全域性種子不同但 RB 種子相同。預設為 None (全域性預設生成器)。

警告

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

示例

>>> import torch
>>>
>>> from torchrl.data import LazyTensorStorage, TensorDictPrioritizedReplayBuffer
>>> from tensordict import TensorDict
>>>
>>> torch.manual_seed(0)
>>>
>>> rb = TensorDictPrioritizedReplayBuffer(alpha=0.7, beta=1.1, storage=LazyTensorStorage(10), batch_size=5)
>>> data = TensorDict({"a": torch.ones(10, 3), ("b", "c"): torch.zeros(10, 3, 1)}, [10])
>>> rb.extend(data)
>>> print("len of rb", len(rb))
len of rb 10
>>> sample = rb.sample(5)
>>> print(sample)
TensorDict(
    fields={
        _weight: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.float32, is_shared=False),
        a: Tensor(shape=torch.Size([5, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([5, 3, 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.int64, is_shared=False)},
    batch_size=torch.Size([5]),
    device=cpu,
    is_shared=False)
>>> print("index", sample["index"])
index tensor([9, 5, 2, 2, 7])
>>> # give a high priority to these samples...
>>> sample.set("td_error", 100*torch.ones(sample.shape))
>>> # and update priority
>>> rb.update_tensordict_priority(sample)
>>> # the new sample should have a high overlap with the previous one
>>> sample = rb.sample(5)
>>> print(sample)
TensorDict(
    fields={
        _weight: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.float32, is_shared=False),
        a: Tensor(shape=torch.Size([5, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([5, 3, 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.int64, is_shared=False)},
    batch_size=torch.Size([5]),
    device=cpu,
    is_shared=False)
>>> print("index", sample["index"])
index tensor([2, 5, 5, 9, 7])

add(data: TensorDictBase) → int¶

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

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

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

將 transform 追加到末尾。

呼叫 sample 時，Transforms 會按順序應用。

引數:: transform (Transform) – 要追加的 transform
關鍵字引數:: invert (bool, optional) – 如果為 True，transform 將被反轉（寫入時呼叫正向呼叫，讀取時呼叫反向呼叫）。預設為 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 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()¶: 清空經驗回放緩衝區並將遊標重置為 0。

extend(tensordicts: TensorDictBase) → Tensor¶

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

如果存在，將呼叫反向 transforms。

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

警告

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

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

插入 transform。

呼叫 sample 時，Transforms 會按順序執行。

引數:

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

關鍵字引數:

invert (bool, optional) – 如果為 True，transform 將被反轉（寫入時呼叫正向呼叫，讀取時呼叫反向呼叫）。預設為 False。

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

loads(path)¶

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

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

引數:: path (Path or 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, include_info: bool = None) → TensorDictBase¶

從經驗回放緩衝區取樣一個批次的資料。

使用 Sampler 取樣索引，並從 Storage 中檢索它們。

引數:

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

返回值:

一個 tensordict，包含在經驗回放緩衝區中選定的批次資料。如果 return_info 標誌設定為 True，則是一個包含此 tensordict 和 info 的 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)¶: 在回放緩衝區中設定新的寫入器，並返回先前的寫入器。

property storage¶

回放緩衝區的儲存器。

儲存器必須是 Storage 的一個例項。

property write_count¶: 透過 add 和 extend 方法至今寫入緩衝區專案的總數。

property writer¶

回放緩衝區的寫入器。

寫入器必須是 Writer 的一個例項。

TensorDictPrioritizedReplayBuffer¶

文件

教程

資源