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