ReplayBufferEnsemble¶

class torchrl.data.replay_buffers.ReplayBufferEnsemble(*rbs, storages: StorageEnsemble | None = None, samplers: SamplerEnsemble | None = None, writers: WriterEnsemble | None = None, transform: Transform | None = None, batch_size: int | None = None, collate_fn: Callable | None = None, collate_fns: list[Callable] | None = None, p: Tensor = None, sample_from_all: bool = False, num_buffer_sampled: int | None = None, generator: torch.Generator | None = None, shared: bool = False, **kwargs)[原始碼]¶

一個回放緩衝區集合。

此類允許一次讀取和取樣多個回放緩衝區。它會自動組合儲存（StorageEnsemble）、寫入器（WriterEnsemble）和取樣器（SamplerEnsemble）的集合。

注意

直接寫入此類是被禁止的，但可以透過索引來檢索巢狀的巢狀緩衝區並對其進行擴充套件。

有兩種不同的方法可以構建 ReplayBufferEnsemble：可以傳遞一個回放緩衝區列表，或者直接傳遞元件（儲存、寫入器和取樣器），就像為其他回放緩衝區子類所做的那樣。

引數:

rbs (ReplayBuffer 例項序列, 可選) – 要組合的回放緩衝區。
storages (StorageEnsemble, 可選) – 儲存集合，如果未傳遞迴放緩衝區。
samplers (SamplerEnsemble, 可選) – 取樣器集合，如果未傳遞迴放緩衝區。
writers (WriterEnsemble, 可選) – 寫入器集合，如果未傳遞迴放緩衝區。
transform (Transform, 可選) – 如果傳遞，這將是回放緩衝區集合的轉換。每個回放緩衝區的單獨轉換將從其父回放緩衝區中檢索，或直接寫入 StorageEnsemble 物件。
batch_size (int, 可選) – 取樣期間使用的批處理大小。
collate_fn (callable, 可選) – 在呼叫每個單獨的 collate_fn 並將資料放在列表中（連同緩衝區 ID）後用於整理資料的函式。
collate_fns (callable 列表, 可選) – 每個巢狀回放緩衝區的 collate_fn。如果未提供，則從 ReplayBuffer 例項中檢索。
p (浮點數列表 或 Tensor, 可選) – 指示每個回放緩衝區相對權重的浮點數列表。如果顯式構建緩衝區，也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
sample_from_all (bool, 可選) – 如果 True，則將從每個資料集中取樣。這與 p 引數不相容。預設為 False。如果顯式構建緩衝區，也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
num_buffer_sampled (int, 可選) – 要取樣的緩衝區數量。如果 sample_from_all=True，則此引數無效，因為它預設為緩衝區數量。如果 sample_from_all=False，緩衝區將根據機率 p 進行取樣。如果顯式構建緩衝區，也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
generator (torch.Generator, optional) –
要用於取樣的生成器。使用專用的生成器用於重放緩衝區可以對種子進行精細控制，例如在分散式作業中使全域性種子不同但 RB 種子相同。預設為 None（全域性預設生成器）。

警告

目前，生成器對變換沒有影響。
shared (bool, optional) – 緩衝區是否將使用多程序共享。預設為 False。

示例

>>> from torchrl.envs import Compose, ToTensorImage, Resize, RenameTransform
>>> from torchrl.data import TensorDictReplayBuffer, ReplayBufferEnsemble, LazyMemmapStorage
>>> from tensordict import TensorDict
>>> import torch
>>> rb0 = TensorDictReplayBuffer(
...     storage=LazyMemmapStorage(10),
...     transform=Compose(
...         ToTensorImage(in_keys=["pixels", ("next", "pixels")]),
...         Resize(32, in_keys=["pixels", ("next", "pixels")]),
...         RenameTransform([("some", "key")], ["renamed"]),
...     ),
... )
>>> rb1 = TensorDictReplayBuffer(
...     storage=LazyMemmapStorage(10),
...     transform=Compose(
...         ToTensorImage(in_keys=["pixels", ("next", "pixels")]),
...         Resize(32, in_keys=["pixels", ("next", "pixels")]),
...         RenameTransform(["another_key"], ["renamed"]),
...     ),
... )
>>> rb = ReplayBufferEnsemble(
...     rb0,
...     rb1,
...     p=[0.5, 0.5],
...     transform=Resize(33, in_keys=["pixels"], out_keys=["pixels33"]),
... )
>>> print(rb)
ReplayBufferEnsemble(
    storages=StorageEnsemble(
        storages=(<torchrl.data.replay_buffers.storages.LazyMemmapStorage object at 0x13a2ef430>, <torchrl.data.replay_buffers.storages.LazyMemmapStorage object at 0x13a2f9310>),
        transforms=[Compose(
                ToTensorImage(keys=['pixels', ('next', 'pixels')]),
                Resize(w=32, h=32, interpolation=InterpolationMode.BILINEAR, keys=['pixels', ('next', 'pixels')]),
                RenameTransform(keys=[('some', 'key')])), Compose(
                ToTensorImage(keys=['pixels', ('next', 'pixels')]),
                Resize(w=32, h=32, interpolation=InterpolationMode.BILINEAR, keys=['pixels', ('next', 'pixels')]),
                RenameTransform(keys=['another_key']))]),
    samplers=SamplerEnsemble(
        samplers=(<torchrl.data.replay_buffers.samplers.RandomSampler object at 0x13a2f9220>, <torchrl.data.replay_buffers.samplers.RandomSampler object at 0x13a2f9f70>)),
    writers=WriterEnsemble(
        writers=(<torchrl.data.replay_buffers.writers.TensorDictRoundRobinWriter object at 0x13a2d9b50>, <torchrl.data.replay_buffers.writers.TensorDictRoundRobinWriter object at 0x13a2f95b0>)),
batch_size=None,
transform=Compose(
        Resize(w=33, h=33, interpolation=InterpolationMode.BILINEAR, keys=['pixels'])),
collate_fn=<built-in method stack of type object at 0x128648260>)
>>> data0 = TensorDict(
...     {
...         "pixels": torch.randint(255, (10, 244, 244, 3)),
...         ("next", "pixels"): torch.randint(255, (10, 244, 244, 3)),
...         ("some", "key"): torch.randn(10),
...     },
...     batch_size=[10],
... )
>>> data1 = TensorDict(
...     {
...         "pixels": torch.randint(255, (10, 64, 64, 3)),
...         ("next", "pixels"): torch.randint(255, (10, 64, 64, 3)),
...         "another_key": torch.randn(10),
...     },
...     batch_size=[10],
... )
>>> rb[0].extend(data0)
>>> rb[1].extend(data1)
>>> for _ in range(2):
...     sample = rb.sample(10)
...     assert sample["next", "pixels"].shape == torch.Size([2, 5, 3, 32, 32])
...     assert sample["pixels"].shape == torch.Size([2, 5, 3, 32, 32])
...     assert sample["pixels33"].shape == torch.Size([2, 5, 3, 33, 33])
...     assert sample["renamed"].shape == torch.Size([2, 5])

add(data: Any) → int¶

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

引數:: 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(data: Sequence, *, update_priority: bool | None = None) → torch.Tensor¶

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

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

引數:: data (iterable) – 要新增到經驗回放緩衝區的元素集合。
關鍵字引數:: update_priority (bool, optional) – 是否更新資料的優先順序。預設為 True。此類中無效。有關更多詳細資訊，請參閱 extend()。
返回:: 新增到經驗回放緩衝區的資料的索引。

警告

extend() 在處理值列表時可能具有歧義的簽名，應將其解釋為 PyTree（在這種情況下，列表中的所有元素都將放入儲存中的 PyTree 片段）或要一次性新增的值列表。為了解決這個問題，TorchRL 區分了列表和元組：元組將被視為 PyTree，列表（在根級別）將被解釋為要一次性新增到緩衝區的值的堆疊。對於 ListStorage 例項，只能提供未繫結的元素（無 PyTrees）。

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

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

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

引數:

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

返回:

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

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 的例項。

ReplayBufferEnsemble¶

文件

教程

資源