GymEnv¶

torchrl.envs.GymEnv(*args, **kwargs)[原始碼]¶

由環境 ID 直接建構的 OpenAI Gym 環境包裝器。

適用於 gymnasium 和 OpenAI/gym。

參數:

env_name (str) – 在 gym.registry 中註冊的環境 ID。
categorical_action_encoding (bool, optional) – 如果 True，categorical specs 將轉換為 TorchRL 對等項 (torchrl.data.Categorical)，否則將使用 one-hot 編碼 (torchrl.data.OneHot)。預設為 False。

關鍵字引數:

num_envs (int, optional) – 並行執行的環境數量。預設為 None（將執行單一環境）。預設會使用 AsyncVectorEnv。
disable_env_checker (bool, optional) – 僅適用於 gym > 0.24。如果 True（這些版本的預設值），則不會執行環境檢查器。
from_pixels (bool, optional) – 如果 True，將嘗試從環境傳回像素觀測值。預設情況下，這些觀測值將寫入 "pixels" 條目下。所使用的方法會因 gym 版本而異，並且可能涉及 wrappers.pixel_observation.PixelObservationWrapper。預設為 False。
pixels_only (bool, optional) – 如果 True，則只會傳回像素觀測值（預設情況下在輸出 tensordict 中的 "pixels" 條目下）。如果 False，只要 from_pixels=True，就會傳回觀測值（例如，狀態）和像素。預設為 False。
frame_skip (int, optional) – 如果提供，表示要重複相同動作的步數。傳回的觀測值將是序列的最後一次觀測值，而獎勵將是跨步數的獎勵總和。
device (torch.device, optional) – 如果提供，資料要轉換到的裝置。預設為 torch.device("cpu")。
batch_size (torch.Size, optional) – 環境的批次大小。應該與所有觀測值、done 狀態、獎勵、動作和資訊的前導維度相符。預設為 torch.Size([])。
allow_done_after_reset (bool, optional) – 如果 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'>

注意

如果沒有提供其他的讀取器，資訊字典將使用 default_info_dict_reader 讀取。要提供其他的讀取器，請參考 set_info_dict_reader()。要自動註冊 info_dict 的內容，請參考 torchrl.envs.GymLikeEnv.auto_register_info_dict()。

注意

Gym spaces 並未完全涵蓋。如果以下 spaces 可以用 torch.Tensor、巢狀 tensor 和/或 tensordict 表示，則將被考慮在內。

spaces.Box

spaces.Sequence

spaces.Tuple

spaces.Discrete

spaces.MultiBinary

spaces.MultiDiscrete

spaces.Dict

使用 gym spaces 時應考慮一些事項。例如，只有當 spaces 在語義上相同（相同的 dtype 和相同的維度數）時，才能支援 spaces 的元組。不規則維度可以透過 nested_tensor() 支援，但這樣只能有一個層級的元組，並且資料應該沿著第一個維度堆疊（因為 nested_tensors 只能沿著第一個維度堆疊）。

請查看 examples/envs/gym_conversion_examples.py 中的範例以了解更多資訊！

GymEnv¶

文件

教程

资源