Wrappers¶

class gymnasium.vector.VectorWrapper(env: VectorEnv)[source]¶

包装向量化环境以允许模块化转换。

此类是所有向量化环境 wrappers 的基类。子类可以覆盖某些方法来更改原始向量化环境的行为，而无需触及原始代码。

注意

如果子类覆盖 __init__()，请不要忘记调用 super().__init__(env)。

参数:: env – 要包装的环境

step(actions: ActType) → tuple[ObsType, ArrayType, ArrayType, ArrayType, dict[str, Any]][source]¶: 使用 actions 步进所有环境，返回批量数据。

reset(*, seed: int | list[int] | None = None, options: dict[str, Any] | None = None) → tuple[ObsType, dict[str, Any]][source]¶: 使用 seed 和 options 重置所有环境。

render() → tuple[RenderFrame, ...] | None[source]¶: 从基础向量环境返回渲染模式。

close(**kwargs: Any)[source]¶: 关闭所有环境。

class gymnasium.vector.VectorObservationWrapper(env: VectorEnv)[source]¶

包装向量化环境以允许模块化转换观测。

等效于向量化环境的 gymnasium.ObservationWrapper。

参数:: env – 向量环境。

observations(observations: ObsType) → ObsType[source]¶

定义向量观测转换。

参数:: observations – 来自环境的向量观测
返回:: 转换后的观测

class gymnasium.vector.VectorActionWrapper(env: VectorEnv)[source]¶

包装向量化环境以允许模块化转换 actions。

等效于向量化环境的 gymnasium.ActionWrapper。

参数:: env – 要包装的环境

actions(actions: ActType) → ActType[source]¶

在将 actions 发送到环境之前对其进行转换。

参数:: actions (ActType) – 要转换的 actions
返回:: ActType – 转换后的 actions

class gymnasium.vector.VectorRewardWrapper(env: VectorEnv)[source]¶

包装向量化环境以允许模块化转换奖励。

等效于向量化环境的 gymnasium.RewardWrapper。

参数:: env – 要包装的环境

rewards(rewards: ArrayType) → ArrayType[source]¶

在返回奖励之前对其进行转换。

参数:: rewards (array) – 要转换的奖励
返回:: array – 转换后的奖励

仅向量 wrappers¶

class gymnasium.wrappers.vector.DictInfoToList(env: VectorEnv)[source]¶

将向量化环境的 infos 从 dict 转换为 List[dict]。

此 wrapper 将向量环境的 info 格式从字典转换为字典列表。此 wrapper 旨在用于向量化环境周围。如果使用其他对 info 执行操作的 wrappers，例如 RecordEpisodeStatistics，则这需要是最外层的 wrapper。

即 DictInfoToList(RecordEpisodeStatistics(vector_env))

示例

>>> import numpy as np
>>> dict_info = {
...      "k": np.array([0., 0., 0.5, 0.3]),
...      "_k": np.array([False, False, True, True])
...  }
...
>>> list_info = [{}, {}, {"k": 0.5}, {"k": 0.3}]

向量环境的示例

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3)
>>> obs, info = envs.reset(seed=123)
>>> info
{}
>>> envs = DictInfoToList(envs)
>>> obs, info = envs.reset(seed=123)
>>> info
[{}, {}, {}]

向量环境的另一个示例

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("HalfCheetah-v4", num_envs=2)
>>> _ = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> _, _, _, _, infos = envs.step(envs.action_space.sample())
>>> infos
{'x_position': array([0.03332211, 0.10172355]), '_x_position': array([ True,  True]), 'x_velocity': array([-0.06296527,  0.89345848]), '_x_velocity': array([ True,  True]), 'reward_run': array([-0.06296527,  0.89345848]), '_reward_run': array([ True,  True]), 'reward_ctrl': array([-0.24503504, -0.21944423], dtype=float32), '_reward_ctrl': array([ True,  True])}
>>> envs = DictInfoToList(envs)
>>> _ = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> _, _, _, _, infos = envs.step(envs.action_space.sample())
>>> infos
[{'x_position': np.float64(0.0333221090036294), 'x_velocity': np.float64(-0.06296527291998574), 'reward_run': np.float64(-0.06296527291998574), 'reward_ctrl': np.float32(-0.24503504)}, {'x_position': np.float64(0.10172354684460168), 'x_velocity': np.float64(0.8934584807363618), 'reward_run': np.float64(0.8934584807363618), 'reward_ctrl': np.float32(-0.21944423)}]

更改日志

v0.24.0 - 最初添加为 VectorListInfo
v1.0.0 - 重命名为 DictInfoToList

参数:: env (Env) – 应用 wrapper 的环境

class gymnasium.wrappers.vector.VectorizeTransformObservation(env: VectorEnv, wrapper: type[TransformObservation], **kwargs: Any)[source]¶

向量化向量环境的单智能体转换观测 wrapper。

大多数用于单智能体环境的 lambda 观测 wrappers 都有向量化实现，建议用户直接使用这些实现，方法是从 gymnasium.wrappers.vector… 导入。以下示例说明了需要自定义 lambda 观测 wrapper 的用例。

示例 - 正常观测

>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> envs.close()
>>> obs
array([[ 0.01823519, -0.0446179 , -0.02796401, -0.03156282],
       [ 0.02852531,  0.02858594,  0.0469136 ,  0.02480598],
       [ 0.03517495, -0.000635  , -0.01098382, -0.03203924]],
      dtype=float32)

示例 - 应用自定义 lambda 观测 wrapper，该 wrapper 复制来自环境的观测

>>> import numpy as np
>>> import gymnasium as gym
>>> from gymnasium.spaces import Box
>>> from gymnasium.wrappers import TransformObservation
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> old_space = envs.single_observation_space
>>> new_space = Box(low=np.array([old_space.low, old_space.low]), high=np.array([old_space.high, old_space.high]))
>>> envs = VectorizeTransformObservation(envs, wrapper=TransformObservation, func=lambda x: np.array([x, x]), observation_space=new_space)
>>> obs, info = envs.reset(seed=123)
>>> envs.close()
>>> obs
array([[[ 0.01823519, -0.0446179 , -0.02796401, -0.03156282],
        [ 0.01823519, -0.0446179 , -0.02796401, -0.03156282]],

       [[ 0.02852531,  0.02858594,  0.0469136 ,  0.02480598],
        [ 0.02852531,  0.02858594,  0.0469136 ,  0.02480598]],

       [[ 0.03517495, -0.000635  , -0.01098382, -0.03203924],
        [ 0.03517495, -0.000635  , -0.01098382, -0.03203924]]],
      dtype=float32)

参数:

env – 要包装的向量环境。
wrapper – 要向量化的 wrapper
**kwargs – wrapper 的关键字参数

class gymnasium.wrappers.vector.VectorizeTransformAction(env: VectorEnv, wrapper: type[TransformAction], **kwargs: Any)[source]¶

向量化向量环境的单智能体转换动作 wrapper。

示例 - 无动作转换

>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
>>> envs.close()
>>> obs
array([[-4.6343064e-01,  9.8971417e-05],
       [-4.4488689e-01, -1.9375233e-03],
       [-4.3118435e-01, -1.5342437e-03]], dtype=float32)

示例 - 添加将 ReLU 应用于动作的转换

>>> import gymnasium as gym
>>> from gymnasium.wrappers import TransformAction
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = VectorizeTransformAction(envs, wrapper=TransformAction, func=lambda x: (x > 0.0) * x, action_space=envs.single_action_space)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
>>> envs.close()
>>> obs
array([[-4.6343064e-01,  9.8971417e-05],
       [-4.4354835e-01, -5.9898634e-04],
       [-4.3034542e-01, -6.9532328e-04]], dtype=float32)

参数:

env – 要包装的向量环境
wrapper – 要向量化的 wrapper
**kwargs – LambdaAction wrapper 的参数

class gymnasium.wrappers.vector.VectorizeTransformReward(env: VectorEnv, wrapper: type[TransformReward], **kwargs: Any)[source]¶

向量化向量环境的单智能体转换奖励 wrapper。

应用 ReLU 到奖励的示例

>>> import gymnasium as gym
>>> from gymnasium.wrappers import TransformReward
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = VectorizeTransformReward(envs, wrapper=TransformReward, func=lambda x: (x > 0.0) * x)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
>>> envs.close()
>>> rew
array([-0., -0., -0.])

参数:

env – 要包装的向量环境。
wrapper – 要向量化的 wrapper
**kwargs – wrapper 的关键字参数

向量化通用 wrappers¶

class gymnasium.wrappers.vector.RecordEpisodeStatistics(env: VectorEnv, buffer_length: int = 100, stats_key: str = 'episode')[source]¶

此 wrapper 将跟踪累积奖励和 episode 长度。

在向量化 env 中任何 episode 结束时，episode 的统计信息将使用键 episode 添加到 info 中，_episode 键用于指示具有终止或截断 episode 的环境索引。

>>> infos = {  
...     ...
...     "episode": {
...         "r": "<array of cumulative reward for each done sub-environment>",
...         "l": "<array of episode length for each done sub-environment>",
...         "t": "<array of elapsed time since beginning of episode for each done sub-environment>"
...     },
...     "_episode": "<boolean array of length num-envs>"
... }

此外，最近的奖励和 episode 长度存储在缓冲区中，可以通过 wrapped_env.return_queue 和 wrapped_env.length_queue 分别访问。

变量:

return_queue – 最后 deque_size-多个 episodes 的累积奖励
length_queue – 最后 deque_size-多个 episodes 的长度

示例

>>> from pprint import pprint
>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3)
>>> envs = RecordEpisodeStatistics(envs)
>>> obs, info = envs.reset(123)
>>> _ = envs.action_space.seed(123)
>>> end = False
>>> while not end:
...     obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
...     end = term.any() or trunc.any()
...
>>> envs.close()
>>> pprint(info) 
{'_episode': array([ True, False, False]),
 '_final_info': array([ True, False, False]),
 '_final_observation': array([ True, False, False]),
 'episode': {'l': array([11,  0,  0], dtype=int32),
             'r': array([11.,  0.,  0.], dtype=float32),
             't': array([0.007812, 0.      , 0.      ], dtype=float32)},
 'final_info': array([{}, None, None], dtype=object),
 'final_observation': array([array([ 0.11448676,  0.9416149 , -0.20946532, -1.7619033 ], dtype=float32),
       None, None], dtype=object)}

参数:

env (Env) – 应用 wrapper 的环境
buffer_length – 缓冲区 return_queue、length_queue 和 time_queue 的大小
stats_key – 用于保存数据的 info 键

已实现的观测 wrappers¶

class gymnasium.wrappers.vector.TransformObservation(env: VectorEnv, func: Callable[[ObsType], Any], observation_space: Space | None = None, single_observation_space: Space | None = None)[source]¶

通过提供给 wrapper 的函数转换观测。

此函数允许手动指定向量观测函数以及单观测函数。当例如可以并行或通过其他更优化的方法处理向量观测时，这是理想的。否则，应使用 VectorizeTransformObservation，其中只需要定义 single_func。

示例 - 无观测转换

>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs
array([[ 0.01823519, -0.0446179 , -0.02796401, -0.03156282],
       [ 0.02852531,  0.02858594,  0.0469136 ,  0.02480598],
       [ 0.03517495, -0.000635  , -0.01098382, -0.03203924]],
      dtype=float32)
  >>> envs.close()

示例 - 有观测转换

>>> import gymnasium as gym
>>> from gymnasium.spaces import Box
>>> def scale_and_shift(obs):
...     return (obs - 1.0) * 2.0
...
>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> new_obs_space = Box(low=envs.observation_space.low, high=envs.observation_space.high)
>>> envs = TransformObservation(envs, func=scale_and_shift, observation_space=new_obs_space)
>>> obs, info = envs.reset(seed=123)
>>> obs
array([[-1.9635296, -2.0892358, -2.055928 , -2.0631256],
       [-1.9429494, -1.9428282, -1.9061728, -1.9503881],
       [-1.9296501, -2.00127  , -2.0219676, -2.0640786]], dtype=float32)
>>> envs.close()

参数:

env – 要包装的向量环境
func – 将转换向量观测的函数。如果此转换后的观测超出 env.observation_space 的观测空间，则提供 observation_space。
observation_space – wrapper 的观测空间。如果为 None，则从 single_observation_space 计算得出。如果 single_observation_space 也未提供，则假定与 env.observation_space 相同。
single_observation_space – 非向量化环境的观测空间。如果为 None，则假定与 env.single_observation_space 相同。

class gymnasium.wrappers.vector.FilterObservation(env: VectorEnv, filter_keys: Sequence[str | int])[source]¶

用于过滤 dict 或 tuple 观测空间的向量 wrapper。

示例 - 创建具有 Dict 空间的向量化环境，以演示如何过滤键

>>> import numpy as np
>>> import gymnasium as gym
>>> from gymnasium.spaces import Dict, Box
>>> from gymnasium.wrappers import TransformObservation
>>> from gymnasium.wrappers.vector import VectorizeTransformObservation, FilterObservation
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> make_dict = lambda x: {"obs": x, "junk": np.array([0.0])}
>>> new_space = Dict({"obs": envs.single_observation_space, "junk": Box(low=-1.0, high=1.0)})
>>> envs = VectorizeTransformObservation(env=envs, wrapper=TransformObservation, func=make_dict, observation_space=new_space)
>>> envs = FilterObservation(envs, ["obs"])
>>> obs, info = envs.reset(seed=123)
>>> envs.close()
>>> obs
{'obs': array([[ 0.01823519, -0.0446179 , -0.02796401, -0.03156282],
       [ 0.02852531,  0.02858594,  0.0469136 ,  0.02480598],
       [ 0.03517495, -0.000635  , -0.01098382, -0.03203924]],
      dtype=float32)}

参数:

env – 要包装的向量环境
filter_keys – 要包含的子空间，对 Dict 和 Tuple 空间分别使用字符串或整数列表

class gymnasium.wrappers.vector.FlattenObservation(env: VectorEnv)[source]¶

展平观测的观测 wrapper。

示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CarRacing-v3", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 96, 96, 3)
>>> envs = FlattenObservation(envs)
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 27648)
>>> envs.close()

参数:: env – 要包装的向量环境

class gymnasium.wrappers.vector.GrayscaleObservation(env: VectorEnv, keep_dim: bool = False)[source]¶

将 RGB 图像转换为灰度的观测 wrapper。

示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CarRacing-v3", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 96, 96, 3)
>>> envs = GrayscaleObservation(envs)
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 96, 96)
>>> envs.close()

参数:

env – 要包装的向量环境
keep_dim – 是否在观测中保留通道，如果 True，obs.shape == 3，否则 obs.shape == 2

class gymnasium.wrappers.vector.ResizeObservation(env: VectorEnv, shape: tuple[int, ...])[source]¶

使用 OpenCV 将图像观测调整为 shape。

示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CarRacing-v3", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 96, 96, 3)
>>> envs = ResizeObservation(envs, shape=(28, 28))
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 28, 28, 3)
>>> envs.close()

参数:

env – 要包装的向量环境
shape – 调整大小后的观测 shape

class gymnasium.wrappers.vector.ReshapeObservation(env: VectorEnv, shape: int | tuple[int, ...])[source]¶

将基于数组的观测重塑为 shapes。

示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CarRacing-v3", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 96, 96, 3)
>>> envs = ReshapeObservation(envs, shape=(9216, 3))
>>> obs, info = envs.reset(seed=123)
>>> obs.shape
(3, 9216, 3)
>>> envs.close()

参数:

env – 要包装的向量环境
shape – 重塑后的观测空间

class gymnasium.wrappers.vector.RescaleObservation(env: VectorEnv, min_obs: np.floating | np.integer | np.ndarray, max_obs: np.floating | np.integer | np.ndarray)[source]¶

线性地将观测值重新缩放到最小值和最大值之间。

示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCar-v0", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.min()
np.float32(-0.46352962)
>>> obs.max()
np.float32(0.0)
>>> envs = RescaleObservation(envs, min_obs=-5.0, max_obs=5.0)
>>> obs, info = envs.reset(seed=123)
>>> obs.min()
np.float32(-0.90849805)
>>> obs.max()
np.float32(0.0)
>>> envs.close()

参数:

env – 要包装的向量环境
min_obs – 新的最小观测边界
max_obs – 新的最大观测边界

class gymnasium.wrappers.vector.DtypeObservation(env: VectorEnv, dtype: Any)[source]¶

用于转换观测值数据类型的包装器。

示例

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> obs.dtype
dtype('float32')
>>> envs = DtypeObservation(envs, dtype=np.float64)
>>> obs, info = envs.reset(seed=123)
>>> obs.dtype
dtype('float64')
>>> envs.close()

参数:

env – 要包装的向量环境
dtype – 观测值的新数据类型

class gymnasium.wrappers.vector.NormalizeObservation(env: VectorEnv, epsilon: float = 1e-8)[source]¶

此包装器将标准化观测值，使得每个坐标都以单位方差为中心。

属性 _update_running_mean 允许冻结/继续观测统计的运行均值计算。如果 True (默认)，则 RunningMeanStd 将在每一步和重置调用时更新。如果 False，则使用计算的统计信息，但不再更新；这可能在评估期间使用。

注意

标准化取决于过去的轨迹，如果包装器是新实例化的或策略最近更改过，则观测值将无法正确标准化。

不使用标准化奖励包装器的示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> obs, info = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> for _ in range(100):
...     obs, *_ = envs.step(envs.action_space.sample())
>>> np.mean(obs)
np.float32(0.024251968)
>>> np.std(obs)
np.float32(0.62259156)
>>> envs.close()

使用标准化奖励包装器的示例

>>> import gymnasium as gym
>>> envs = gym.make_vec("CartPole-v1", num_envs=3, vectorization_mode="sync")
>>> envs = NormalizeObservation(envs)
>>> obs, info = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> for _ in range(100):
...     obs, *_ = envs.step(envs.action_space.sample())
>>> np.mean(obs)
np.float32(-0.2359734)
>>> np.std(obs)
np.float32(1.1938739)
>>> envs.close()

参数:

env (Env) – 应用 wrapper 的环境
epsilon – 用于缩放观测值的稳定性参数。

已实现的动作包装器¶

class gymnasium.wrappers.vector.TransformAction(env: VectorEnv, func: Callable[[ActType], Any], action_space: Space | None = None, single_action_space: Space | None = None)[source]¶

通过提供给包装器的函数转换动作。

函数 func 将应用于所有向量动作。如果来自 func 的观测值超出 env 的动作空间边界，请提供一个 action_space，它指定向量化环境的动作空间。

示例 - 无动作转换

>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> for _ in range(10):
...     obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
...
>>> envs.close()
>>> obs
array([[-0.46553135, -0.00142543],
       [-0.498371  , -0.00715587],
       [-0.46515748, -0.00624371]], dtype=float32)

示例 - 使用动作转换

>>> import gymnasium as gym
>>> from gymnasium.spaces import Box
>>> def shrink_action(act):
...     return act * 0.3
...
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> new_action_space = Box(low=shrink_action(envs.action_space.low), high=shrink_action(envs.action_space.high))
>>> envs = TransformAction(env=envs, func=shrink_action, action_space=new_action_space)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> for _ in range(10):
...     obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
...
>>> envs.close()
>>> obs
array([[-0.48468155, -0.00372536],
       [-0.47599354, -0.00545912],
       [-0.46543318, -0.00615723]], dtype=float32)

参数:

env – 要包装的向量环境
func – 将转换动作的函数。如果此转换后的动作超出 env.action_space 的动作空间，则提供一个 action_space。
action_space – 包装器的动作空间。如果为 None，则从 single_action_space 计算得出。如果 single_action_space 也未提供，则假定与 env.action_space 相同。
single_action_space – 非向量化环境的动作空间。如果为 None，则假定与 env.single_action_space 相同。

class gymnasium.wrappers.vector.ClipAction(env: VectorEnv)[source]¶

将连续动作裁剪到有效的 Box 观测空间边界内。

示例 - 将超出范围的动作传递给环境以进行裁剪。

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = ClipAction(envs)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> obs, rew, term, trunc, info = envs.step(np.array([5.0, -5.0, 2.0]))
>>> envs.close()
>>> obs
array([[-0.4624777 ,  0.00105192],
       [-0.44504836, -0.00209899],
       [-0.42884544,  0.00080468]], dtype=float32)

参数:: env – 要包装的向量环境

class gymnasium.wrappers.vector.RescaleAction(env: VectorEnv, min_action: float | int | np.ndarray, max_action: float | int | np.ndarray)[source]¶

将环境的连续动作空间仿射地重新缩放到范围 [min_action, max_action]。

示例 - 不使用动作缩放

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> for _ in range(10):
...     obs, rew, term, trunc, info = envs.step(0.5 * np.ones((3, 1)))
...
>>> envs.close()
>>> obs
array([[-0.44799727,  0.00266526],
       [-0.4351738 ,  0.00133522],
       [-0.42683297,  0.00048403]], dtype=float32)

示例 - 使用动作缩放

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = RescaleAction(envs, 0.0, 1.0)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> for _ in range(10):
...     obs, rew, term, trunc, info = envs.step(0.5 * np.ones((3, 1)))
...
>>> envs.close()
>>> obs
array([[-0.48657528, -0.00395268],
       [-0.47377947, -0.00529102],
       [-0.46546045, -0.00614867]], dtype=float32)

参数:

env (Env) – 要包装的向量环境
min_action (float, int or np.ndarray) – 每个动作的最小值。这可以是 numpy 数组或标量。
max_action (float, int or np.ndarray) – 每个动作的最大值。这可以是 numpy 数组或标量。

已实现的奖励包装器¶

class gymnasium.wrappers.vector.TransformReward(env: VectorEnv, func: Callable[[ArrayType], ArrayType])[source]¶

一个奖励包装器，允许自定义函数修改步进奖励。

使用奖励转换的示例

>>> import gymnasium as gym
>>> from gymnasium.spaces import Box
>>> def scale_and_shift(rew):
...     return (rew - 1.0) * 2.0
...
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = TransformReward(env=envs, func=scale_and_shift)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> obs, rew, term, trunc, info = envs.step(envs.action_space.sample())
>>> envs.close()
>>> obs
array([[-4.6343064e-01,  9.8971417e-05],
       [-4.4488689e-01, -1.9375233e-03],
       [-4.3118435e-01, -1.5342437e-03]], dtype=float32)

参数:

env (Env) – 要包装的向量环境
func – (Callable): 应用于奖励的函数

class gymnasium.wrappers.vector.ClipReward(env: VectorEnv, min_reward: float | np.ndarray | None = None, max_reward: float | np.ndarray | None = None)[source]¶

一个包装器，用于将环境的奖励裁剪在上限和下限之间。

使用裁剪奖励的示例

>>> import numpy as np
>>> import gymnasium as gym
>>> envs = gym.make_vec("MountainCarContinuous-v0", num_envs=3)
>>> envs = ClipReward(envs, 0.0, 2.0)
>>> _ = envs.action_space.seed(123)
>>> obs, info = envs.reset(seed=123)
>>> for _ in range(10):
...     obs, rew, term, trunc, info = envs.step(0.5 * np.ones((3, 1)))
...
>>> envs.close()
>>> rew
array([0., 0., 0.])

参数:

env – 要包装的向量环境
min_reward – 每一步的最小奖励
max_reward – 每一步的最大奖励

class gymnasium.wrappers.vector.NormalizeReward(env: VectorEnv, gamma: float = 0.99, epsilon: float = 1e-8)[source]¶

此包装器将缩放奖励，使其指数移动平均值具有近似固定的方差。

属性 _update_running_mean 允许冻结/继续奖励统计的运行均值计算。如果 True (默认)，则 RunningMeanStd 将在每次调用 self.normalize() 时更新。如果为 False，则使用计算的统计信息，但不再更新；这可能在评估期间使用。

注意

缩放取决于过去的轨迹，如果包装器是新实例化的或策略最近更改过，则奖励将无法正确缩放。

不使用标准化奖励包装器的示例

>>> import gymnasium as gym
>>> import numpy as np
>>> envs = gym.make_vec("MountainCarContinuous-v0", 3)
>>> _ = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> episode_rewards = []
>>> for _ in range(100):
...     observation, reward, *_ = envs.step(envs.action_space.sample())
...     episode_rewards.append(reward)
...
>>> envs.close()
>>> np.mean(episode_rewards)
np.float64(-0.03359492141887935)
>>> np.std(episode_rewards)
np.float64(0.029028230434438706)

使用标准化奖励包装器的示例

>>> import gymnasium as gym
>>> import numpy as np
>>> envs = gym.make_vec("MountainCarContinuous-v0", 3)
>>> envs = NormalizeReward(envs)
>>> _ = envs.reset(seed=123)
>>> _ = envs.action_space.seed(123)
>>> episode_rewards = []
>>> for _ in range(100):
...     observation, reward, *_ = envs.step(envs.action_space.sample())
...     episode_rewards.append(reward)
...
>>> envs.close()
>>> np.mean(episode_rewards)
np.float64(-0.1598639586606745)
>>> np.std(episode_rewards)
np.float64(0.27800309628058434)

参数:

env (env) – 要应用包装器的环境
epsilon (float) – 稳定性参数
gamma (float) – 指数移动平均值中使用的折扣因子。

已实现的数据转换包装器¶

class gymnasium.wrappers.vector.JaxToNumpy(env: VectorEnv)[source]¶

包装一个 jax 向量环境，以便可以通过 numpy 数组与之交互。

注释

向量化版本的 gymnasium.wrappers.JaxToNumpy

动作必须作为 numpy 数组提供，观测值、奖励、终止和截断将作为 numpy 数组返回。

示例

>>> import gymnasium as gym                                         
>>> envs = gym.make_vec("JaxEnv-vx", 3)                             
>>> envs = JaxToNumpy(envs)                                         

参数:: env – 要包装的向量 jax 环境

class gymnasium.wrappers.vector.JaxToTorch(env: VectorEnv, device: Device | None = None)[source]¶

包装一个基于 Jax 的向量环境，以便可以通过 PyTorch 张量与之交互。

动作必须作为 PyTorch 张量提供，观测值、奖励、终止和截断将作为 PyTorch 张量返回。

示例

>>> import gymnasium as gym                                         
>>> envs = gym.make_vec("JaxEnv-vx", 3)                             
>>> envs = JaxToTorch(envs)                                         

参数:

env – 要包装的基于 Jax 的向量环境
device – torch 张量应移动到的设备

class gymnasium.wrappers.vector.NumpyToTorch(env: VectorEnv, device: Device | None = None)[source]¶

包装一个基于 numpy 的环境，以便可以通过 PyTorch 张量与之交互。

示例

>>> import torch
>>> import gymnasium as gym
>>> from gymnasium.wrappers.vector import NumpyToTorch
>>> envs = gym.make_vec("CartPole-v1", 3)
>>> envs = NumpyToTorch(envs)
>>> obs, _ = envs.reset(seed=123)
>>> type(obs)
<class 'torch.Tensor'>
>>> action = torch.tensor(envs.action_space.sample())
>>> obs, reward, terminated, truncated, info = envs.step(action)
>>> envs.close()
>>> type(obs)
<class 'torch.Tensor'>
>>> type(reward)
<class 'torch.Tensor'>
>>> type(terminated)
<class 'torch.Tensor'>
>>> type(truncated)
<class 'torch.Tensor'>

参数:

env – 要包装的基于 Jax 的向量环境
device – torch 张量应移动到的设备