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)，否则将使用 one-hot 编码 (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() 后，可以容忍 envs 处于 done 状态。默认为 False。
convert_actions_to_numpy (bool, optional) – 如果为 True，则动作将从张量转换为 numpy 数组，并在传递给 env step 函数之前移动到 CPU。如果环境在 GPU 上评估（例如 IsaacLab），则将其设置为 False。默认为 True。

变量:

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 空间时应考虑一些事项。例如，只有当空间的语义相同（相同的 dtype 和相同数量的维度）时，才能支持空间元组。可以通过 nested_tensor() 支持不规则维度，但随后应该只有一个元组级别，并且数据应沿第一个维度堆叠（因为 nested_tensors 只能沿第一个维度堆叠）。

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

GymWrapper¶

文档

教程

资源