TensorDictReplayBuffer¶

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

TensorDict 的包裝器，用於 ReplayBuffer 類。

關鍵字引數:

storage (Storage, Callable[], Storage], optional) – 要使用的儲存。如果傳入的是可呼叫物件，則將其用作儲存的建構函式。如果未提供，則使用預設的 ListStorage，其 max_size 為 1_000。
sampler (Sampler, Callable[], Sampler], optional) – 要使用的取樣器。如果傳入的是可呼叫物件，則將其用作取樣器的建構函式。如果未提供，則使用預設的 RandomSampler。
writer (Writer, Callable[], Writer], optional) – 要使用的寫入器。如果傳入的是可呼叫物件，則將其用作寫入器的建構函式。如果未提供，則使用預設的 TensorDictRoundRobinWriter。
collate_fn (callable, optional) – 將樣本列表合併以形成 Tensor/輸出的 mini-batch。在使用 map-style 資料集的批次載入時使用。預設值將根據儲存型別確定。
pin_memory (bool) – 是否應對 rb 樣本呼叫 pin_memory()。
prefetch (int, optional) – 要透過多執行緒預取的下一個批次數。預設為 None（無預取）。
transform (Transform 或 Callable[Any], Any], optional) – 呼叫 sample() 時要執行的變換。要連結變換，請使用 Compose 類。變換應與 tensordict.TensorDict 內容一起使用。如果重放緩衝區與 PyTree 結構一起使用（參見下面的示例），也可以傳入一個通用的可呼叫物件。與儲存、寫入器和取樣器不同，變換建構函式必須作為單獨的關鍵字引數 transform_factory 傳入，因為無法區分建構函式和變換。
transform_factory (Callable[[], Callable], optional) – 變換的工廠。與 transform 互斥。
batch_size (int, optional) –
呼叫 sample() 時要使用的批次大小。

注意

批次大小可以在構造時透過 batch_size 引數指定，或者在取樣時指定。當批次大小在整個實驗中保持一致時，前者是首選。如果批次大小可能會發生變化，則可以將其傳遞給 sample() 方法。此選項與預取（因為這需要提前知道批次大小）以及具有 drop_last 引數的取樣器不相容。
priority_key (str, optional) – 新增到此 ReplayBuffer 的 TensorDict 中假定儲存優先順序的位置。當取樣器為 PrioritizedSampler 型別時使用。預設為 "td_error"。
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（全域性預設生成器）。

警告

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

示例

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

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

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

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

將變換附加到末尾。

呼叫 sample 時按順序應用變換。

引數:: transform (Transform) – 要附加的變換
關鍵字引數:: invert (bool, optional) – 如果為 True，則轉換將被反轉（寫入時呼叫正向呼叫，讀取時呼叫反向呼叫）。預設為 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()

classmethod as_remote(remote_config=None)¶

建立一個遠端 ray 類的例項。

引數:

cls (Python Class) – 要遠端例項化的類。
remote_config (dict) – 為該類保留的 CPU 核心數量。預設為 torchrl.collectors.distributed.ray.DEFAULT_REMOTE_CLASS_CONFIG。

返回:

一個建立 ray 遠端類例項的函式。

property batch_size¶

重放緩衝區的批次大小。

可以透過在 sample() 方法中設定 batch_size 引數來覆蓋批次大小。

它定義了 sample() 返回的樣本數量以及 ReplayBuffer 迭代器生成的樣本數量。

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(empty_write_count: bool = True)¶

清空重放緩衝區並將遊標重置為 0。

引數:: empty_write_count (bool, optional) – 是否清空 write_count 屬性。預設為 True。

extend(tensordicts: TensorDictBase, *, update_priority: bool | None = None) → torch.Tensor[source]¶

使用資料批次擴充套件重放緩衝區。

引數:: tensordicts (TensorDictBase) – 用於擴充套件重放緩衝區的資料。
關鍵字引數:: update_priority (bool, optional) – 是否更新資料的優先順序。預設為 True。
返回:: 已新增到重放緩衝區的資料的索引。

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

插入變換。

呼叫 sample 時按順序執行變換。

引數:

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

關鍵字引數:

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

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

loads(path)¶

在給定路徑載入重放緩衝區狀態。

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

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

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

next()¶

返回重放緩衝區的下一個項。

此方法用於在 __iter__ 不可用的情況下迭代重放緩衝區，例如 RayReplayBuffer。

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 = None) → TensorDictBase[source]¶

從重放緩衝區中取樣資料批次。

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

引數:

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

返回:

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

property sampler: Sampler¶

重放緩衝區的取樣器。

取樣器必須是 Sampler 的例項。

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

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

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

在重放緩衝區中設定新的儲存並返回之前的儲存。

引數:

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

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

property storage: Storage¶

重放緩衝區的儲存。

儲存器必須是 Storage 的例項。

property write_count: int¶: 透過 add 和 extend 寫入緩衝區的總項數。

property writer: Writer¶

重放緩衝區的寫入器。

寫入器必須是 Writer 的例項。

TensorDictReplayBuffer¶

文件

教程

資源