RayReplayBuffer

class torchrl.data.RayReplayBuffer(*args, replay_buffer_cls: type[ReplayBuffer] | None = <class 'torchrl.data.replay_buffers.replay_buffers.ReplayBuffer'>, ray_init_config: dict[str, Any] | None = None, remote_config: dict[str, Any] | None = None, **kwargs)

一個 Ray 實現的 Replay Buffer，可以進行擴充套件並在遠端進行取樣。

關鍵字引數:

• replay_buffer_cls (type[ReplayBuffer], optional) – 用於回放緩衝區的類。預設為 ReplayBuffer。

• ray_init_config (dict[str, Any], optiona) – 傳遞給 ray.init() 的關鍵字引數。

• remote_config (dict[str, Any], optiona) – 傳遞給 cls.as_remote() 的關鍵字引數。預設為 torchrl.collectors.distributed.ray.DEFAULT_REMOTE_CLASS_CONFIG。

• **kwargs – 傳遞給回放緩衝區類的關鍵字引數。

另請參閱

ReplayBuffer 的其他關鍵字引數列表。

應將 writer、sampler 和 storage 作為建構函式傳遞，以防止序列化問題。轉換建構函式應透過 transform_factory 引數傳遞。

示例

>>> import asyncio
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> from torchrl.collectors.distributed.ray import RayCollector
>>> from torchrl.data.replay_buffers.ray_buffer import RayReplayBuffer
>>> from torchrl.envs.libs.gym import GymEnv
>>>
>>> async def main():
...     # 1. Create environment factory
...     def env_maker():
...         return GymEnv("Pendulum-v1", device="cpu")
...
...     policy = TensorDictModule(
...         nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"]
...     )
...
...     buffer = RayReplayBuffer()
...
...     # 2. Define distributed collector
...     remote_config = {
...         "num_cpus": 1,
...         "num_gpus": 0,
...         "memory": 5 * 1024**3,
...         "object_store_memory": 2 * 1024**3,
...     }
...     distributed_collector = RayCollector(
...         [env_maker],
...         policy,
...         total_frames=600,
...         frames_per_batch=200,
...         remote_configs=remote_config,
...         replay_buffer=buffer,
...     )
...
...     print("start")
...     distributed_collector.start()
...
...     while True:
...         while not len(buffer):
...             print("waiting")
...             await asyncio.sleep(1)  # Use asyncio.sleep instead of time.sleep
...         print("sample", buffer.sample(32))
...         # break at some point
...         break
...
...     await distributed_collector.async_shutdown()
>>>
>>> if __name__ == "__main__":
...     asyncio.run(main())

add(*args, **kwargs)

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

引數:

data (Any) – 要新增到重放緩衝區的資料

返回:

資料在重放緩衝區中的索引。

append_transform(*args, **kwargs)

將變換附加到末尾。

呼叫 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 迭代器生成的樣本數量。

close()

終止與此回放緩衝區關聯的 Ray actor。

dump(path)

別名為 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(*args, **kwargs)

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

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

引數:

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(*args, **kwargs)

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

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

引數:

• batch_size (int, optional) – 要收集的資料的大小。如果未提供，此方法將取樣由取樣器指示的批次大小。

• return_info (bool) – 是否返回資訊。如果為 True，則結果為元組 (data, info)。如果為 False，則結果為資料。

返回:

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

property sampler: Sampler

重放緩衝區的取樣器。

取樣器必須是 Sampler 的例項。

save(path: str)

別名為 dumps()。

set_sampler(sampler)

在重放緩衝區中設定新的取樣器並返回之前的取樣器。

set_storage(storage)

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

引數:

• storage (Storage) – 緩衝區的新的儲存。

• collate_fn (callable, optional) – 如果提供，collate_fn 將設定為此值。否則，它將被重置為預設值。

set_writer(writer)

在重放緩衝區中設定新的寫入器並返回之前的寫入器。

property storage: Storage

重放緩衝區的儲存。

儲存器必須是 Storage 的例項。

property write_count

透過 add 和 extend 寫入緩衝區的總項數。

property writer: Writer

重放緩衝區的寫入器。

寫入器必須是 Writer 的例項。