TensorDictReplayBuffer¶

class torchrl.data.TensorDictReplayBuffer(*, priority_key: str = 'td_error', **kwargs)[原始碼]¶

TensorDict 專用封裝器，圍繞 ReplayBuffer 類別。

關鍵字引數:

storage (Storage, optional) – 要使用的儲存空間。如果未提供，將建立預設的 ListStorage，其 max_size 為 1_000。
sampler (Sampler, optional) – 要使用的取樣器。如果未提供，將使用預設的 RandomSampler()。
writer (Writer, optional) – 要使用的寫入器。如果未提供，將使用預設的 RoundRobinWriter。
collate_fn (callable, optional) – 合併樣本列表以形成 Tensor(s)/輸出的 mini-batch。從地圖樣式資料集使用批次載入時使用。預設值將根據儲存類型決定。
pin_memory (bool) – 是否應在 rb 樣本上呼叫 pin_memory()。
prefetch (int, optional) – 使用多執行緒預先提取的下一個批次的數量。預設為 None (無預先提取)。
transform (Transform, optional) – 當呼叫 sample() 時要執行的轉換。若要串聯轉換，請使用 Compose 類別。轉換應該與 tensordict.TensorDict 內容一起使用。如果與其他結構一起使用，則轉換應使用 "data" 前導鍵進行編碼，該鍵將用於從非 tensordict 內容建構 tensordict。

batch_size (int, optional) –

呼叫 sample() 時要使用的批次大小。 .. note

The batch-size can be specified at construction time via the
``batch_size`` argument, or at sampling time. The former should
be preferred whenever the batch-size is consistent across the
experiment. If the batch-size is likely to change, it can be
passed to the :meth:`~.sample` method. This option is
incompatible with prefetching (since this requires to know the
batch-size in advance) as well as with samplers that have a
``drop_last`` argument.

priority_key (str, optional) – 優先順序儲存在新增到此 ReplayBuffer 的 TensorDict 內的鍵。當 sampler 的類型為 PrioritizedSampler 時使用。預設值為 "td_error"。
dim_extend (int, optional) –
指示呼叫 extend() 時要考慮擴展的維度。預設值為 storage.ndim-1。當使用 dim_extend > 0 時，我們建議在使用 storage 實例化時使用 ndim 引數 (如果該引數可用)，以便讓 storage 知道資料是多維的，並在取樣期間保持儲存容量和批次大小的一致概念。
Note

此引數對 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) –
用於取樣的產生器。為重播緩衝區使用專用的產生器可以實現對 seeding 的細粒度控制，例如保持全域 seed 不同，但對於分散式作業，RB seed 相同。預設值為 None (全域預設產生器)。

Warning

到目前為止，產生器對轉換沒有影響。
shared (bool, optional) – 是否使用多處理共享緩衝區。預設值為 False。

Examples

>>> 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]¶

將單個元素新增到重播緩衝區。

Parameters:: data (Any) – 要新增到重播緩衝區的資料
Returns:: 資料在重播緩衝區中的索引。

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

在末尾附加轉換。

當呼叫 sample 時，轉換會按順序套用。

Parameters:: transform (Transform) – 要附加的轉換
關鍵字引數:: invert (bool, optional) – 如果 True，則會反轉轉換（正向呼叫將在寫入期間呼叫，反向呼叫將在讀取期間呼叫）。預設值為 False。

Example

>>> 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)¶

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

Parameters:: path (Path 或 str) – 要儲存重播緩衝區的路徑。

Examples

>>> 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]¶

使用可迭代物件中包含的一個或多個元素擴展重播緩衝區。

如果存在，將呼叫反向轉換。`

Parameters:: data (iterable) – 要新增到重播緩衝區的資料集合。
Returns:: 新增到重播緩衝區的資料的索引。

Warning

當處理數值列表時，extend() 可能會有含糊不清的簽章，此時應該將其解讀為 PyTree（這種情況下，列表中的所有元素都會放入儲存的 PyTree 中的一個切片），還是應該解讀為一個個添加到緩衝區的數值列表。為了避免這種情況，TorchRL 明確地區分了列表和元組：元組會被視為 PyTree，而列表（在根層級）會被解讀為要一個個添加到緩衝區的值堆疊。對於 ListStorage 實例，只能提供未綁定的元素（沒有 PyTrees）。

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

插入 transform。

當呼叫 sample 時，Transforms 會依序執行。

Parameters:

index (int) – 插入 transform 的位置。
transform (Transform) – 要附加的轉換

關鍵字引數:

invert (bool, optional) – 如果 True，則會反轉轉換（正向呼叫將在寫入期間呼叫，反向呼叫將在讀取期間呼叫）。預設值為 False。

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

loads(path)¶

在給定的路徑載入 replay buffer 狀態。

buffer 應該具有匹配的組件，並使用 dumps() 儲存。

Parameters:: path (Path 或 str) – 儲存 replay buffer 的路徑。

請參閱 dumps() 以獲取更多資訊。

register_load_hook(hook: Callable[[Any], Any])¶: 為儲存體註冊一個載入 hook。

Note

Hooks 目前在儲存 replay buffer 時不會被序列化：每次創建 buffer 時都必須手動重新初始化。

register_save_hook(hook: Callable[[Any], Any])¶: 為儲存體註冊一個儲存 hook。

Note

Hooks 目前在儲存 replay buffer 時不會被序列化：每次創建 buffer 時都必須手動重新初始化。

sample(batch_size: Optional[int] = None, return_info: bool = False, include_info: Optional[bool] = None) → TensorDictBase[原始碼]¶

從 replay buffer 中取樣一批資料。

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

Parameters:

batch_size (int, optional) – 要收集的資料大小。如果沒有提供，此方法將按照 sampler 指示的批次大小進行取樣。
return_info (bool) – 是否傳回 info。如果為 True，結果將是一個元組 (data, info)。如果為 False，結果將是 data。

Returns:

一個包含在 replay buffer 中選取的一批資料的 tensordict。如果 return_info 標誌設定為 True，則包含此 tensordict 和 info 的元組。

property sampler¶

replay buffer 的 sampler。

sampler 必須是 Sampler 的實例。

save(*args, **kwargs)¶: 是 dumps() 的別名。

set_sampler(sampler: Sampler)¶: 設定回放緩衝區中的新取樣器 (sampler)，並返回先前的取樣器。

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

設定回放緩衝區中的新儲存體 (storage)，並返回先前的儲存體。

Parameters:

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

set_writer(writer: Writer)¶: 設定回放緩衝區中的新寫入器 (writer)，並返回先前的寫入器。

property storage¶

回放緩衝區的儲存體。

儲存體必須是 Storage 的一個實例。

property write_count¶: 通過 add 和 extend 在緩衝區中到目前為止寫入的項目總數。

property writer¶

回放緩衝區的寫入器。

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

TensorDictReplayBuffer¶

文件

Tutorials

Resources