GymEnv¶

torchrl.envs.GymEnv(*args, **kwargs)[源]¶

直接通过环境 ID 构建的 OpenAI Gym 环境包装器。

兼容 gymnasium 和 OpenAI/gym。

参数:

env_name (str) – 在 gym.registry 中注册的环境 ID。
categorical_action_encoding (bool, 可选) – 如果为 True，分类规范将被转换为等效的 TorchRL 类型 (torchrl.data.Categorical)，否则将使用 one-hot 编码 (torchrl.data.OneHot)。默认为 False。

关键字参数:

num_envs (int, 可选) – 并行运行的环境数量。默认为 None (运行单个环境)。默认将使用 AsyncVectorEnv。
disable_env_checker (bool, 可选) – 仅适用于 gym > 0.24。如果为 True (这些版本的默认值)，将不会运行环境检查器。
from_pixels (bool, 可选) – 如果为 True，将尝试从环境中返回像素观察值。默认情况下，这些观察值将写入 "pixels" 条目下。使用的方法因 gym 版本而异，可能涉及 wrappers.pixel_observation.PixelObservationWrapper。默认为 False。
pixels_only (bool, 可选) – 如果为 True，将仅返回像素观察值 (默认在输出 tensordict 的 "pixels" 条目下)。如果为 False，当 from_pixels=True 时，将返回观察值 (例如状态) 和像素。默认为 False。
frame_skip (int, 可选) – 如果提供，指示重复同一动作的步数。返回的观察值将是序列中的最后一个观察值，而奖励将是所有步的奖励总和。
device (torch.device, 可选) – 如果提供，数据将要转换到的设备。默认为 torch.device("cpu")。
batch_size (torch.Size, 可选) – 环境的批大小。应与所有观察值、完成状态、奖励、动作和信息的前导维度匹配。默认为 torch.Size([])。
allow_done_after_reset (bool, 可选) – 如果为 True，则允许环境在调用 reset() 后立即处于 done 状态。默认为 False。

变量:

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

注意

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

>>> from torchrl.envs import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> print(env.spec.max_episode_steps)
200

如果某个用例 TorchRL 未涵盖，请在 GitHub 上提交 issue。

示例

>>> from torchrl.envs import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> 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',

注意

如果虚拟环境中同时存在 OpenAI/gym 和 gymnasium，可以使用 set_gym_backend() 切换后端。

>>> from torchrl.envs import set_gym_backend, GymEnv
>>> with set_gym_backend("gym"):
...     env = GymEnv("Pendulum-v1")
...     print(env._env)
<class 'gym.wrappers.time_limit.TimeLimit'>
>>> with set_gym_backend("gymnasium"):
...     env = GymEnv("Pendulum-v1")
...     print(env._env)
<class 'gymnasium.wrappers.time_limit.TimeLimit'>

注意

如果没有提供其他读取器，info 字典将使用 default_info_dict_reader 读取。要提供其他读取器，请参考 set_info_dict_reader()。要自动注册 info_dict 内容，请参考 torchrl.envs.GymLikeEnv.auto_register_info_dict()。

注意

Gym 空间并未完全涵盖。只要能通过 torch.Tensor、嵌套张量和/或 tensordict 表示，就支持以下空间：

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

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

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

GymEnv¶

文档

教程

资源