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)，否則將使用獨熱編碼 (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() 後立即將環境設定為 done。預設為 False。
convert_actions_to_numpy (bool, optional) – 如果為 True，在傳遞給 env 的 step 函式之前，動作將從張量轉換為 numpy 陣列並移至 CPU。如果環境在 GPU 上進行評估，例如 IsaacLab，請將其設定為 False。預設為 True。
missing_obs_value (Any, optional) – 當環境自動重置且在 info 字典中找不到缺失的觀察值時（例如，使用 IsaacLab），用作缺失觀察值的預設佔位符值。此引數透過元類傳遞給 VecGymEnvTransform。

變數:

available_envs (List[str]) – 要構建的環境列表。

注意

如果找不到某個屬性，此類將嘗試從巢狀的環境中檢索它

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

注意

info 字典將使用 default_info_dict_reader 讀取，除非提供了其他讀取器。要提供其他讀取器，請參考 set_info_dict_reader()。要自動註冊 info_dict 的內容，請參考 torchrl.envs.GymLikeEnv.auto_register_info_dict()。對於並行（向量化）環境，info 字典讀取器會自動設定，不應手動設定。

注意

Gym spaces 的覆蓋不完全。以下 spaces 已考慮在內，前提是它們可以由 torch.Tensor、巢狀張量和/或 tensordict 表示

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

在使用 gym spaces 時應考慮一些因素。例如，spaces 的元組只有在 spaces 語義上相同（相同的 dtype 和相同的維度數）時才受支援。可以透過 nested_tensor() 支援 Ragged dimension，但此時元組只能有一個級別，並且資料應沿第一個維度堆疊（因為 nested_tensors 只能沿第一個維度堆疊）。

請檢視 examples/envs/gym_conversion_examples.py 中的示例以瞭解更多資訊！

GymWrapper¶

文件

教程

資源