GymWrapper¶

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

OpenAI Gym 环境包装器。

适用于 gymnasium 和 OpenAI/gym。

参数：:

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

关键字参数：:

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

变量：:

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

注意

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

>>> 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',

注意

信息字典将使用 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 空间时，应考虑一些事项。例如，只有当空间在语义上相同（相同数据类型和相同维数）时，才能支持空间元组。不规则维度可以通过 nested_tensor() 支持，但然后应该只存在一层元组，并且数据应该沿着第一个维度堆叠（因为嵌套张量只能沿着第一个维度堆叠）。

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

GymWrapper¶

文档

教程

资源