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)[source]¶
回放緩衝區的集合。
此類允許同時從多個回放緩衝區中讀取和取樣。它自動組合了儲存集合(
StorageEnsemble)、寫入器(WriterEnsemble)和取樣器(SamplerEnsemble)。注意
禁止直接寫入此類,但可以透過索引檢索巢狀的緩衝區並進行擴充套件。
構建
ReplayBufferEnsemble有兩種不同的方式:可以傳遞一個回放緩衝區列表,或者直接傳遞元件(儲存、寫入器和取樣器),就像其他回放緩衝區子類那樣。- 引數:
rbs (ReplayBuffer 例項序列,可選) – 要集合的回放緩衝區。
storages (StorageEnsemble,可選) – 儲存集合,如果未傳遞迴放緩衝區。
samplers (SamplerEnsemble,可選) – 取樣器集合,如果未傳遞迴放緩衝區。
writers (WriterEnsemble,可選) – 寫入器集合,如果未傳遞迴放緩衝區。
transform (Transform,可選) – 如果傳遞,這將是回放緩衝區集合的變換。每個回放緩衝區的獨立變換從其父回放緩衝區中檢索,或直接寫入
StorageEnsemble物件中。batch_size (整數,可選) – 取樣時使用的 batch-size。
collate_fn (可呼叫物件,可選) – 在呼叫每個獨立的 collate_fn 並且資料被放入列表(連同緩衝區 ID)後,用於整理資料(collate)的函式。
collate_fns (可呼叫物件列表,可選) – 每個巢狀回放緩衝區的 collate_fn。如果未提供,則從
ReplayBuffer例項中檢索。p (浮點數列表或 Tensor,可選) – 一個浮點數列表,指示每個回放緩衝區的相對權重。如果緩衝區是顯式構建的,也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。
sample_from_all (布林值,可選) – 如果
True,將從每個資料集進行取樣。這與引數p不相容。預設為False。如果緩衝區是顯式構建的,也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。num_buffer_sampled (整數,可選) – 要取樣的緩衝區數量。如果
sample_from_all=True,此引數無效,因為它預設為緩衝區數量。如果sample_from_all=False,緩衝區將根據機率p進行取樣。如果緩衝區是顯式構建的,也可以傳遞給 torchrl.data.replay_buffers.samplers.SamplerEnsemble`。generator (torch.Generator,可選) –
用於取樣的生成器。為回放緩衝區使用專用的生成器可以實現對種子的精細控制,例如在分散式作業中保持全域性種子不同但 RB 種子相同。預設為
None(全域性預設生成器)。警告
目前,生成器對變換無效。
shared (布林值,可選) – 緩衝區是否使用多程序共享。預設為
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 (任意型別) – 要新增到回放緩衝區的資料
- 返回:
資料在回放緩衝區中的索引。
- append_transform(transform: Transform, *, invert: bool = False) ReplayBuffer¶
將變換新增到末尾。
當呼叫 sample 時,變換按順序應用。
- 引數:
transform (Transform) – 要新增的變換
- 關鍵字引數:
invert (布林值,可選) – 如果
True,變換將被反轉(寫入時呼叫 forward,讀取時呼叫 inverse)。預設為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)¶
將回放緩衝區儲存到磁碟上的指定路徑。
- 引數:
path (Path 或 字串) – 儲存回放緩衝區的路徑。
示例
>>> 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¶
使用可迭代物件中包含的一個或多個元素擴充套件回放緩衝區。
如果存在,將呼叫逆變換。
- 引數:
data (可迭代物件) – 要新增到回放緩衝區的資料集合。
- 返回:
新增到回放緩衝區的資料的索引。
警告
extend()當處理值列表時,可能具有歧義的簽名,這應該被解釋為 PyTree(在這種情況下,列表中的所有元素將被放入儲存中儲存的 PyTree 的一個切片中)或要逐個新增的值列表。為了解決這個問題,TorchRL 對列表和元組做了明確的區分:元組將被視為 PyTree,列表(在根級別)將被解釋為要逐個新增到緩衝區的值堆疊。對於ListStorage例項,只能提供非繫結元素(不能是 PyTrees)。
- insert_transform(index: int, transform: Transform, *, invert: bool = False) ReplayBuffer¶
插入變換。
當呼叫 sample 時,變換按順序執行。
- 引數:
index (整數) – 插入變換的位置。
transform (Transform) – 要新增的變換
- 關鍵字引數:
invert (布林值,可選) – 如果
True,變換將被反轉(寫入時呼叫 forward,讀取時呼叫 inverse)。預設為False。
- load(*args, **kwargs)¶
loads() 的別名。
- loads(path)¶
從給定路徑載入回放緩衝區狀態。
緩衝區應該具有匹配的元件,並且使用
dumps()儲存。- 引數:
path (Path 或 字串) – 回放緩衝區儲存的路徑。
有關更多資訊,請參閱
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 (整數,可選) – 要收集的資料大小。如果未提供,此方法將按照取樣器指示的 batch-size 進行取樣。
return_info (布林值) – 是否返回資訊。如果為 True,結果是元組 (data, info)。如果為 False,結果是資料。
- 返回:
在回放緩衝區中選擇的一批資料。如果設定了 return_info 標誌為 True,則返回一個包含此批資料和資訊的元組。
- save(*args, **kwargs)¶
dumps() 的別名。
- set_storage(storage: Storage, collate_fn: Callable | None = None)¶
在回放緩衝區中設定新的儲存並返回先前的儲存。
- 引數:
storage (Storage) – 緩衝區的新的儲存。
collate_fn (可呼叫物件,可選) – 如果提供,collate_fn 被設定為此值。否則,它將被重置為預設值。
- 屬性 write_count¶
透過 add 和 extend 方法向緩衝區寫入的專案總數。