D4RLExperienceReplay¶

class torchrl.data.datasets.D4RLExperienceReplay(dataset_id, batch_size: int, sampler: Sampler | None = None, writer: Writer | None = None, collate_fn: Callable | None = None, pin_memory: bool = False, prefetch: int | None = None, transform: 'torchrl.envs.Transform' | None = None, split_trajs: bool = False, from_env: bool = False, use_truncated_as_done: bool = True, direct_download: bool = None, terminate_on_end: bool = None, download: bool = True, root: str | Path | None = None, **env_kwargs)[source]¶

D4RL 的经验回放类。

要安装 D4RL，请按照官方仓库上的说明进行操作。

数据格式遵循TED 约定。回放缓冲区包含 D4RLExperienceReplay.specs 下的环境规范。

如果存在，元数据将写入 D4RLExperienceReplay.metadata 并从数据集中排除。

转换使用 done = terminated | truncated 重构，并且 "done" 状态的 ("next", "observation") 被置零。

参数:

dataset_id (str) – 要从中获取数据的 D4RL 环境的 dataset_id。
batch_size (int) – 采样期间使用的批次大小。
sampler (Sampler, 可选) – 要使用的采样器。如果未提供，将使用默认的 RandomSampler()。
writer (Writer, 可选) – 要使用的写入器。如果未提供，将使用默认的ImmutableDatasetWriter。
collate_fn (callable, 可选) – 合并样本列表以形成 Tensor(s)/输出的小批量。当从 map-style 数据集使用批量加载时使用。
pin_memory (bool) – 是否应在 rb 样本上调用 pin_memory()。
prefetch (int, 可选) – 使用多线程预取的下一个批次的数量。
transform (Transform, 可选) – 调用 sample() 时要执行的转换。要链接转换，请使用Compose类。
split_trajs (bool, 可选) – 如果 True，轨迹将沿第一个维度分割并填充以具有匹配的形状。要分割轨迹，将使用 "done" 信号，该信号通过 done = truncated | terminated 恢复。换句话说，假设任何 truncated 或 terminated 信号都等同于轨迹的结束。对于来自 D4RL 的某些数据集，这可能不成立。用户需要对 split_trajs 的这种用法做出准确的选择。默认为 False。
from_env (bool, 可选) –
如果 True，将使用 env.get_dataset() 来检索数据集。否则将使用 d4rl.qlearning_dataset()。默认为 True。

注意

使用 from_env=False 将提供比 from_env=True 更少的数据。例如，info 键将被省略。通常，from_env=False 和 terminate_on_end=True 将导致与 from_env=True 相同的结果，但后者包含前者不具备的元数据和 info 条目。

注意

from_env=True 和 from_env=False 中的键可能会意外地有所不同。特别是，当 from_env=False 时，"truncated" 键（用于确定 episode 的结束）可能不存在，但在其他情况下可能存在，当启用 traj_splits 时会导致不同的切片。
direct_download (bool) – 如果 True，数据将在不需要 D4RL 的情况下下载。如果 None，如果 d4rl 存在于 env 中，它将用于下载数据集，否则下载将回退到 direct_download=True。这与 from_env=True 不兼容。默认为 None。
use_truncated_as_done (bool, 可选) – 如果 True, done = terminated | truncated。否则，仅使用 terminated 键。默认为 True。
terminate_on_end (bool, 可选) – 在轨迹的最后一个时间步设置 done=True。默认值为 False，并将丢弃每个轨迹中的最后一个时间步。这仅与 direct_download=False 一起使用。
root (Path 或 str, 可选) – D4RL 数据集根目录。实际的数据集内存映射文件将保存在 <root>/<dataset_id> 下。如果未提供，则默认为 ``~/.cache/torchrl/d4rl`。
download (bool, 可选) – 如果未找到数据集是否应下载。默认为 True。
**env_kwargs (key-value pairs) – d4rl.qlearning_dataset() 的附加 kwargs。

示例

>>> from torchrl.data.datasets.d4rl import D4RLExperienceReplay
>>> from torchrl.envs import ObservationNorm
>>> data = D4RLExperienceReplay("maze2d-umaze-v1", 128)
>>> # we can append transforms to the dataset
>>> data.append_transform(ObservationNorm(loc=-1, scale=1.0, in_keys=["observation"]))
>>> data.sample(128)

add(data: TensorDictBase) → int¶

向回放缓冲区添加单个元素。

参数:: data (Any) – 要添加到回放缓冲区的数据
返回值:: 数据在回放缓冲区中的索引。

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

在末尾追加转换。

当调用 sample 时，转换按顺序应用。

参数:: transform (Transform) – 要追加的转换
关键字参数:: invert (bool, 可选) – 如果 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()

property data_path: Path¶: 数据集的路径，包括分割。

property data_path_root: Path¶: 数据集根目录的路径。

delete()¶: 从磁盘删除数据集存储。

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()¶: 清空回放缓冲区并将光标重置为 0。

extend(tensordicts: TensorDictBase) → Tensor¶

使用可迭代对象中包含的一个或多个元素扩展回放缓冲区。

如果存在，将调用逆变换。`

参数:: data (iterable) – 要添加到回放缓冲区的数据集合。
返回值:: 添加到回放缓冲区的数据的索引。

警告

当处理值列表时，extend() 可能具有不明确的签名，该签名应解释为 PyTree（在这种情况下，列表中的所有元素都将放入存储中存储的 PyTree 中的切片中）或一次添加一个值的列表。为了解决这个问题，TorchRL 明确区分了列表和元组：元组将被视为 PyTree，列表（在根级别）将被解释为一次添加一个值到缓冲区的堆栈。对于ListStorage实例，只能提供未绑定的元素（没有 PyTree）。

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

插入转换。

当调用 sample 时，转换按顺序执行。

参数:

index (int) – 插入转换的位置。
transform (Transform) – 要追加的转换

关键字参数:

invert (bool, 可选) – 如果 True，转换将被反转（前向调用将在写入期间调用，反向调用将在读取期间调用）。默认为 False。

load(*args, **kwargs)¶: loads() 的别名。

loads(path)¶

加载给定路径的回放缓冲区状态。

缓冲区应具有匹配的组件，并使用 dumps() 保存。

参数:: path (Path 或 str) – 回放缓冲区保存的路径。

有关更多信息，请参见 dumps()。

preprocess(fn: Callable[[TensorDictBase], TensorDictBase], dim: int = 0, num_workers: int | None = None, *, chunksize: int | None = None, num_chunks: int | None = None, pool: mp.Pool | None = None, generator: torch.Generator | None = None, max_tasks_per_child: int | None = None, worker_threads: int = 1, index_with_generator: bool = False, pbar: bool = False, mp_start_method: str | None = None, num_frames: int | None = None, dest: str | Path) → TensorStorage¶

预处理数据集并返回包含格式化数据的新存储。

数据转换必须是 unit 的（作用于数据集的单个样本）。

Args 和 Keyword Args 会被转发到 map()。

数据集随后可以使用 delete() 删除。

关键字参数:

dest (path 或 等效路径) – 新数据集位置的路径。
num_frames (int, 可选) – 如果提供，则仅转换前 num_frames 帧。这在初次调试转换时很有用。

返回：一个新的存储，用于 ReplayBuffer 实例中。

示例

>>> from torchrl.data.datasets import MinariExperienceReplay
>>>
>>> data = MinariExperienceReplay(
...     list(MinariExperienceReplay.available_datasets)[0],
...     batch_size=32
...     )
>>> print(data)
MinariExperienceReplay(
    storages=TensorStorage(TensorDict(
        fields={
            action: MemoryMappedTensor(shape=torch.Size([1000000, 8]), device=cpu, dtype=torch.float32, is_shared=True),
            episode: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.int64, is_shared=True),
            info: TensorDict(
                fields={
                    distance_from_origin: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    forward_reward: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                    qpos: MemoryMappedTensor(shape=torch.Size([1000000, 15]), device=cpu, dtype=torch.float64, is_shared=True),
                    qvel: MemoryMappedTensor(shape=torch.Size([1000000, 14]), device=cpu, dtype=torch.float64, is_shared=True),
                    reward_ctrl: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    reward_forward: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    reward_survive: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    success: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.bool, is_shared=True),
                    x_position: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    x_velocity: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    y_position: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                    y_velocity: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True)},
                batch_size=torch.Size([1000000]),
                device=cpu,
                is_shared=False),
            next: TensorDict(
                fields={
                    done: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True),
                    info: TensorDict(
                        fields={
                            distance_from_origin: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            forward_reward: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                            qpos: MemoryMappedTensor(shape=torch.Size([1000000, 15]), device=cpu, dtype=torch.float64, is_shared=True),
                            qvel: MemoryMappedTensor(shape=torch.Size([1000000, 14]), device=cpu, dtype=torch.float64, is_shared=True),
                            reward_ctrl: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            reward_forward: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            reward_survive: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            success: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.bool, is_shared=True),
                            x_position: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            x_velocity: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            y_position: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True),
                            y_velocity: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float64, is_shared=True)},
                        batch_size=torch.Size([1000000]),
                        device=cpu,
                        is_shared=False),
                    observation: TensorDict(
                        fields={
                            achieved_goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                            desired_goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                            observation: MemoryMappedTensor(shape=torch.Size([1000000, 27]), device=cpu, dtype=torch.float64, is_shared=True)},
                        batch_size=torch.Size([1000000]),
                        device=cpu,
                        is_shared=False),
                    reward: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.float64, is_shared=True),
                    terminated: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True),
                    truncated: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True)},
                batch_size=torch.Size([1000000]),
                device=cpu,
                is_shared=False),
            observation: TensorDict(
                fields={
                    achieved_goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                    desired_goal: MemoryMappedTensor(shape=torch.Size([1000000, 2]), device=cpu, dtype=torch.float64, is_shared=True),
                    observation: MemoryMappedTensor(shape=torch.Size([1000000, 27]), device=cpu, dtype=torch.float64, is_shared=True)},
                batch_size=torch.Size([1000000]),
                device=cpu,
                is_shared=False)},
        batch_size=torch.Size([1000000]),
        device=cpu,
        is_shared=False)),
    samplers=RandomSampler,
    writers=ImmutableDatasetWriter(),
batch_size=32,
transform=Compose(
),
collate_fn=<function _collate_id at 0x120e21dc0>)
>>> from torchrl.envs import CatTensors, Compose
>>> from tempfile import TemporaryDirectory
>>>
>>> cat_tensors = CatTensors(
...     in_keys=[("observation", "observation"), ("observation", "achieved_goal"),
...              ("observation", "desired_goal")],
...     out_key="obs"
...     )
>>> cat_next_tensors = CatTensors(
...     in_keys=[("next", "observation", "observation"),
...              ("next", "observation", "achieved_goal"),
...              ("next", "observation", "desired_goal")],
...     out_key=("next", "obs")
...     )
>>> t = Compose(cat_tensors, cat_next_tensors)
>>>
>>> def func(td):
...     td = td.select(
...         "action",
...         "episode",
...         ("next", "done"),
...         ("next", "observation"),
...         ("next", "reward"),
...         ("next", "terminated"),
...         ("next", "truncated"),
...         "observation"
...         )
...     td = t(td)
...     return td
>>> with TemporaryDirectory() as tmpdir:
...     new_storage = data.preprocess(func, num_workers=4, pbar=True, mp_start_method="fork", dest=tmpdir)
...     rb = ReplayBuffer(storage=new_storage)
...     print(rb)
ReplayBuffer(
    storage=TensorStorage(
        data=TensorDict(
            fields={
                action: MemoryMappedTensor(shape=torch.Size([1000000, 8]), device=cpu, dtype=torch.float32, is_shared=True),
                episode: MemoryMappedTensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.int64, is_shared=True),
                next: TensorDict(
                    fields={
                        done: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True),
                        obs: MemoryMappedTensor(shape=torch.Size([1000000, 31]), device=cpu, dtype=torch.float64, is_shared=True),
                        observation: TensorDict(
                            fields={
                            },
                            batch_size=torch.Size([1000000]),
                            device=cpu,
                            is_shared=False),
                        reward: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.float64, is_shared=True),
                        terminated: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True),
                        truncated: MemoryMappedTensor(shape=torch.Size([1000000, 1]), device=cpu, dtype=torch.bool, is_shared=True)},
                    batch_size=torch.Size([1000000]),
                    device=cpu,
                    is_shared=False),
                obs: MemoryMappedTensor(shape=torch.Size([1000000, 31]), device=cpu, dtype=torch.float64, is_shared=True),
                observation: TensorDict(
                    fields={
                    },
                    batch_size=torch.Size([1000000]),
                    device=cpu,
                    is_shared=False)},
            batch_size=torch.Size([1000000]),
            device=cpu,
            is_shared=False),
        shape=torch.Size([1000000]),
        len=1000000,
        max_size=1000000),
    sampler=RandomSampler(),
    writer=RoundRobinWriter(cursor=0, full_storage=True),
    batch_size=None,
    collate_fn=<function _collate_id at 0x168406fc0>)

register_load_hook(hook: Callable[[Any], Any])¶: 为存储注册一个加载钩子。

注意

钩子在保存回放缓冲区时目前不会被序列化：每次创建缓冲区时都必须手动重新初始化它们。

register_save_hook(hook: Callable[[Any], Any])¶: 为存储注册一个保存钩子。

注意

钩子在保存回放缓冲区时目前不会被序列化：每次创建缓冲区时都必须手动重新初始化它们。

sample(batch_size: Optional[int] = None, return_info: bool = False, include_info: Optional[bool] = None) → TensorDictBase¶

从回放缓冲区中采样一批数据。

使用 Sampler 采样索引，并从 Storage 中检索它们。

参数:

batch_size (int, 可选) – 要收集的数据大小。如果未提供，此方法将按照采样器指示的大小采样 batch-size。
return_info (bool) – 是否返回 info。如果为 True，结果是一个元组 (data, info)。如果为 False，结果是数据。

返回值:

一个包含在回放缓冲区中选择的数据批次的 tensordict。如果 return_info 标志设置为 True，则为一个包含此 tensordict 和 info 的元组。

property sampler¶

回放缓冲区的采样器。

采样器必须是 Sampler 的实例。

save(*args, **kwargs)¶: dumps() 的别名。

set_sampler(sampler: Sampler)¶: 在回放缓冲区中设置一个新的采样器，并返回之前的采样器。

set_storage(storage: Storage, collate_fn: Optional[Callable] = None)¶

在回放缓冲区中设置一个新的存储，并返回之前的存储。

参数:

storage (Storage) – 缓冲区的新的存储。
collate_fn (callable, 可选) – 如果提供，则 collate_fn 将设置为此值。否则，它将被重置为默认值。

set_writer(writer: Writer)¶: 在回放缓冲区中设置一个新的写入器，并返回之前的写入器。

property storage¶

回放缓冲区的存储。

存储必须是 Storage 的实例。

property write_count¶: 通过 add 和 extend 方法，到目前为止在缓冲区中写入的总项目数。

property writer¶

回放缓冲区的写入器。

写入器必须是 Writer 的实例。

D4RLExperienceReplay¶

文档

Tutorials

Resources