GymEnv¶

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

透過環境 ID 直接構造的 OpenAI Gym 環境包裝器。

適用於 gymnasium 和 OpenAI/gym。

引數:

env_name (str) – 在 gym.registry 中註冊的環境 ID。
categorical_action_encoding (bool, optional) – 如果為 True，則分類規範將轉換為 TorchRL 等效項 (torchrl.data.Categorical)，否則將使用獨熱編碼 (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) – 環境的批次大小。應與所有觀察、完成狀態、獎勵、動作和資訊的前導維度匹配。預設為 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 上提交一個問題。

示例

>>> 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 空間不完全覆蓋。以下空間將被考慮在內，前提是它們可以由 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¶

文件

教程

資源