GymWrapper¶

torchrl.envs.GymWrapper(*args, **kwargs)[源代码]¶

OpenAI Gym 环境封装器。

支持 gymnasium 和 OpenAI/gym。

参数:

env (gym.Env) – 要封装的环境。支持批量环境（VecEnv 或 gym.VectorEnv），环境的批量大小将反映并行执行的环境数量。
categorical_action_encoding (bool, optional) – 如果为 True，则分类规范将转换为 TorchRL 等效项 (torchrl.data.Categorical)，否则将使用独热编码 (torchrl.data.OneHot)。默认为 False。

关键字参数:

from_pixels (bool, optional) – 如果为 True，则会尝试从环境中返回像素观察。默认情况下，这些观察将被写入 "pixels" 条目下。所使用的方法取决于 gym 的版本，并可能涉及 wrappers.pixel_observation.PixelObservationWrapper。默认为 False。
pixels_only (bool, optional) – 如果设置为 True，将只返回像素观察（默认在输出 tensordict 的 "pixels" 条目下）。如果设置为 False，当 from_pixels=True 时，将返回观察（例如，状态）和像素。默认为 True。
frame_skip (int, optional) – 如果提供，表示相同的动作需要重复多少步。返回的观察值将是序列的最后一个观察值，而奖励将是跨步骤的奖励总和。
device (torch.device, optional) – 如果提供，数据将被转换到的设备。默认为 torch.device("cpu")。
batch_size (torch.Size, optional) – 环境的批次大小。应与所有观察、完成状态、奖励、动作和信息的前导维度匹配。默认为 torch.Size([])。
allow_done_after_reset (bool, optional) – 如果为 True，则允许在调用 reset() 后立即将环境设置为 done。默认为 False。
convert_actions_to_numpy (bool, optional) – 如果为 True，在传递给 env 的 step 函数之前，动作将从张量转换为 numpy 数组并移至 CPU。如果环境在 GPU 上进行评估，例如 IsaacLab，请将其设置为 False。默认为 True。
missing_obs_value (Any, optional) – 当环境自动重置且在 info 字典中找不到缺失的观察值时（例如，使用 IsaacLab），用作缺失观察值的默认占位符值。此参数通过元类传递给 VecGymEnvTransform。

变量:

available_envs (List[str]) – 要构建的环境列表。

注意

如果找不到某个属性，此类将尝试从嵌套的环境中检索它

>>> from torchrl.envs import GymWrapper
>>> import gymnasium as gym
>>> env = GymWrapper(gym.make("Pendulum-v1"))
>>> print(env.spec.max_episode_steps)
200

示例

>>> import gymnasium as gym
>>> from torchrl.envs import GymWrapper
>>> base_env = gym.make("Pendulum-v1")
>>> env = GymWrapper(base_env)
>>> td = env.rand_step()
>>> print(td)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=cpu,
    is_shared=False)
>>> print(env.available_envs)
['ALE/Adventure-ram-v5', 'ALE/Adventure-v5', 'ALE/AirRaid-ram-v5', 'ALE/AirRaid-v5', 'ALE/Alien-ram-v5', 'ALE/Alien-v5',

注意

info 字典将使用 default_info_dict_reader 读取，除非提供了其他读取器。要提供其他读取器，请参考 set_info_dict_reader()。要自动注册 info_dict 的内容，请参考 torchrl.envs.GymLikeEnv.auto_register_info_dict()。对于并行（矢量化）环境，info 字典读取器会自动设置，不应手动设置。

注意

Gym spaces 的覆盖不完全。以下 spaces 已考虑在内，前提是它们可以由 torch.Tensor、嵌套张量和/或 tensordict 表示

spaces.Box
spaces.Sequence
spaces.Tuple
spaces.Discrete
spaces.MultiBinary
spaces.MultiDiscrete
spaces.Dict

在使用 gym spaces 时应考虑一些因素。例如，spaces 的元组只有在 spaces 语义上相同（相同的 dtype 和相同的维度数）时才受支持。可以通过 nested_tensor() 支持 Ragged dimension，但此时元组只能有一个级别，并且数据应沿第一个维度堆叠（因为 nested_tensors 只能沿第一个维度堆叠）。

请查看 examples/envs/gym_conversion_examples.py 中的示例以了解更多信息！

GymWrapper¶

文档

教程

资源