创建你自己的自定义环境

本文档概述了创建新环境和Gymnasium中包含的相关有用包装器、实用程序和测试，这些内容旨在用于创建新环境。

设置

推荐的解决方案

1. 按照 pipx 文档 安装 pipx。

2. 然后安装 Copier：

pipx install copier

替代解决方案

使用 Pip 或 Conda 安装 Copier：

pip install copier

或

conda install -c conda-forge copier

生成你的环境

你可以通过运行以下命令来检查 Copier 是否已正确安装，该命令应输出一个版本号：

copier --version

然后你可以运行以下命令，并将字符串 path/to/directory 替换为你想要创建新项目的目录路径。

copier copy https://github.com/Farama-Foundation/gymnasium-env-template.git "path/to/directory"

回答问题，完成后你应该得到一个类似如下的项目结构：

.
├── gymnasium_env
│   ├── envs
│   │   ├── grid_world.py
│   │   └── __init__.py
│   ├── __init__.py
│   └── wrappers
│       ├── clip_reward.py
│       ├── discrete_actions.py
│       ├── __init__.py
│       ├── reacher_weighted_reward.py
│       └── relative_position.py
├── LICENSE
├── pyproject.toml
└── README.md

子类化 gymnasium.Env

在了解如何创建自己的环境之前，你应该查看 Gymnasium 的 API 文档。

为了说明子类化 gymnasium.Env 的过程，我们将实现一个非常简单的游戏，称为 GridWorldEnv。我们将在 gymnasium_env/envs/grid_world.py 中编写自定义环境的代码。该环境由一个固定大小的二维正方形网格组成（在构造时通过 size 参数指定）。在每个时间步，智能体可以在网格单元之间垂直或水平移动。智能体的目标是导航到网格上在每个回合开始时随机放置的目标。

• 观察结果提供了目标和代理的位置。

• 在我们的环境中，有4个动作，分别对应于“向右”、“向上”、“向左”和“向下”的移动。

• 一旦代理导航到目标所在的网格单元，就会发出完成信号。

• 奖励是二进制且稀疏的，这意味着即时奖励总是零，除非代理已经到达目标，那时奖励为1。

在这个环境中的一集（使用 size=5）可能看起来像这样：

其中蓝色点代表智能体，红色方块代表目标。

让我们逐段查看 GridWorldEnv 的源代码：

声明与初始化

我们的自定义环境将从抽象类 gymnasium.Env 继承。你不应该忘记在你的类中添加 metadata 属性。在那里，你应该指定你的环境支持的渲染模式（例如，"human"，"rgb_array"，"ansi"）以及你的环境应该渲染的帧率。每个环境都应该支持 None 作为渲染模式；你不需要在元数据中添加它。在 GridWorldEnv 中，我们将支持“rgb_array”和“human”模式，并以 4 FPS 渲染。

我们环境的 __init__ 方法将接受整数 size，该整数决定了方形网格的大小。我们将设置一些用于渲染的变量，并定义 self.observation_space 和 self.action_space。在我们的例子中，观察结果应提供有关代理和目标在二维网格上的位置信息。我们将选择以字典形式表示观察结果，键为 "agent" 和 "target"。一个观察结果可能看起来像 {"agent": array([1, 0]), "target": array([0, 3])}。由于我们的环境中共有4个动作（“向右”，“向上”，“向左”，“向下”），我们将使用 Discrete(4) 作为动作空间。以下是 GridWorldEnv 的声明和 __init__ 的实现：

# gymnasium_env/envs/grid_world.py
from enum import Enum

import numpy as np
import pygame

import gymnasium as gym
from gymnasium import spaces


class Actions(Enum):
    RIGHT = 0
    UP = 1
    LEFT = 2
    DOWN = 3


class GridWorldEnv(gym.Env):
    metadata = {"render_modes": ["human", "rgb_array"], "render_fps": 4}

    def __init__(self, render_mode=None, size=5):
        self.size = size  # The size of the square grid
        self.window_size = 512  # The size of the PyGame window

        # Observations are dictionaries with the agent's and the target's location.
        # Each location is encoded as an element of {0, ..., `size`}^2, i.e. MultiDiscrete([size, size]).
        self.observation_space = spaces.Dict(
            {
                "agent": spaces.Box(0, size - 1, shape=(2,), dtype=int),
                "target": spaces.Box(0, size - 1, shape=(2,), dtype=int),
            }
        )
        self._agent_location = np.array([-1, -1], dtype=int)
        self._target_location = np.array([-1, -1], dtype=int)

        # We have 4 actions, corresponding to "right", "up", "left", "down"
        self.action_space = spaces.Discrete(4)

        """
        The following dictionary maps abstract actions from `self.action_space` to
        the direction we will walk in if that action is taken.
        i.e. 0 corresponds to "right", 1 to "up" etc.
        """
        self._action_to_direction = {
            Actions.RIGHT.value: np.array([1, 0]),
            Actions.UP.value: np.array([0, 1]),
            Actions.LEFT.value: np.array([-1, 0]),
            Actions.DOWN.value: np.array([0, -1]),
        }

        assert render_mode is None or render_mode in self.metadata["render_modes"]
        self.render_mode = render_mode

        """
        If human-rendering is used, `self.window` will be a reference
        to the window that we draw to. `self.clock` will be a clock that is used
        to ensure that the environment is rendered at the correct framerate in
        human-mode. They will remain `None` until human-mode is used for the
        first time.
        """
        self.window = None
        self.clock = None

从环境状态构建观察结果

由于我们需要在 reset 和 step 中计算观察结果，通常有一个（私有的）方法 _get_obs 将环境的状态转换为观察结果会很方便。然而，这并不是强制性的，你也可以分别在 reset 和 step 中计算观察结果：

def _get_obs(self):
    return {"agent": self._agent_location, "target": self._target_location}

我们也可以为 step 和 reset 返回的辅助信息实现类似的方法。在我们的例子中，我们希望提供代理和目标之间的曼哈顿距离：

def _get_info(self):
    return {
        "distance": np.linalg.norm(
            self._agent_location - self._target_location, ord=1
        )
    }

通常，信息还会包含一些只能在 step 方法内部获得的数据（例如，个别奖励项）。在这种情况下，我们必须在 step 中更新由 _get_info 返回的字典。

重置

reset 方法将被调用来启动一个新的回合。你可以假设在 reset 被调用之前不会调用 step 方法。此外，每当发出完成信号时，都应该调用 reset。用户可以通过 seed 关键字传递给 reset 来将环境中使用的任何随机数生成器初始化为确定性状态。建议使用环境基类 gymnasium.Env 提供的随机数生成器 self.np_random。如果你只使用这个RNG，你不需要太担心种子问题，但你需要记住调用 ``super().reset(seed=seed)`` 以确保 gymnasium.Env 正确地为RNG设置种子。一旦完成这些，我们就可以随机设置我们环境的状态。在我们的例子中，我们随机选择代理的位置和随机样本目标位置，直到它与代理的位置不一致。

reset 方法应返回一个初始观测值和一些辅助信息的元组。我们可以使用之前实现的 _get_obs 和 _get_info 方法来实现这一点：

def reset(self, seed=None, options=None):
    # We need the following line to seed self.np_random
    super().reset(seed=seed)

    # Choose the agent's location uniformly at random
    self._agent_location = self.np_random.integers(0, self.size, size=2, dtype=int)

    # We will sample the target's location randomly until it does not coincide with the agent's location
    self._target_location = self._agent_location
    while np.array_equal(self._target_location, self._agent_location):
        self._target_location = self.np_random.integers(
            0, self.size, size=2, dtype=int
        )

    observation = self._get_obs()
    info = self._get_info()

    if self.render_mode == "human":
        self._render_frame()

    return observation, info

步骤

step 方法通常包含环境的大部分逻辑。它接受一个 action，计算应用该动作后的环境状态，并返回 5 元组 (observation, reward, terminated, truncated, info)。参见 gymnasium.Env.step()。一旦计算出环境的新状态，我们可以检查它是否是终止状态，并相应地设置 done。由于我们在 GridWorldEnv 中使用稀疏二进制奖励，一旦我们知道 done，计算 reward 就很简单了。为了收集 observation 和 info，我们可以再次利用 _get_obs 和 _get_info：

def step(self, action):
    # Map the action (element of {0,1,2,3}) to the direction we walk in
    direction = self._action_to_direction[action]
    # We use `np.clip` to make sure we don't leave the grid
    self._agent_location = np.clip(
        self._agent_location + direction, 0, self.size - 1
    )
    # An episode is done iff the agent has reached the target
    terminated = np.array_equal(self._agent_location, self._target_location)
    reward = 1 if terminated else 0  # Binary sparse rewards
    observation = self._get_obs()
    info = self._get_info()

    if self.render_mode == "human":
        self._render_frame()

    return observation, reward, terminated, False, info

渲染

这里，我们使用 PyGame 进行渲染。许多包含在 Gymnasium 中的环境中使用了类似的渲染方法，你可以将其作为自己环境的框架：

def render(self):
    if self.render_mode == "rgb_array":
        return self._render_frame()

def _render_frame(self):
    if self.window is None and self.render_mode == "human":
        pygame.init()
        pygame.display.init()
        self.window = pygame.display.set_mode(
            (self.window_size, self.window_size)
        )
    if self.clock is None and self.render_mode == "human":
        self.clock = pygame.time.Clock()

    canvas = pygame.Surface((self.window_size, self.window_size))
    canvas.fill((255, 255, 255))
    pix_square_size = (
        self.window_size / self.size
    )  # The size of a single grid square in pixels

    # First we draw the target
    pygame.draw.rect(
        canvas,
        (255, 0, 0),
        pygame.Rect(
            pix_square_size * self._target_location,
            (pix_square_size, pix_square_size),
        ),
    )
    # Now we draw the agent
    pygame.draw.circle(
        canvas,
        (0, 0, 255),
        (self._agent_location + 0.5) * pix_square_size,
        pix_square_size / 3,
    )

    # Finally, add some gridlines
    for x in range(self.size + 1):
        pygame.draw.line(
            canvas,
            0,
            (0, pix_square_size * x),
            (self.window_size, pix_square_size * x),
            width=3,
        )
        pygame.draw.line(
            canvas,
            0,
            (pix_square_size * x, 0),
            (pix_square_size * x, self.window_size),
            width=3,
        )

    if self.render_mode == "human":
        # The following line copies our drawings from `canvas` to the visible window
        self.window.blit(canvas, canvas.get_rect())
        pygame.event.pump()
        pygame.display.update()

        # We need to ensure that human-rendering occurs at the predefined framerate.
        # The following line will automatically add a delay to keep the framerate stable.
        self.clock.tick(self.metadata["render_fps"])
    else:  # rgb_array
        return np.transpose(
            np.array(pygame.surfarray.pixels3d(canvas)), axes=(1, 0, 2)
        )

关闭

close 方法应关闭环境中使用的任何打开的资源。在许多情况下，您实际上不必费心实现此方法。然而，在我们的示例中，render_mode 可能是 "human"，我们可能需要关闭已打开的窗口：

def close(self):
    if self.window is not None:
        pygame.display.quit()
        pygame.quit()

在其他环境中，close 可能还会关闭已打开的文件或释放其他资源。在调用 close 之后，你不应该与环境进行交互。

注册环境

为了使自定义环境能够被 Gymnasium 检测到，它们必须按照以下方式注册。我们选择将此代码放在 gymnasium_env/__init__.py 中。

from gymnasium.envs.registration import register

register(
    id="gymnasium_env/GridWorld-v0",
    entry_point="gymnasium_env.envs:GridWorldEnv",
)

环境ID由三个部分组成，其中两个是可选的：一个可选的命名空间（这里：gymnasium_env），一个强制性的名称（这里：GridWorld），以及一个可选但推荐的版本（这里：v0）。它也可能被注册为``GridWorld-v0``（推荐的方法），GridWorld``或``gymnasium_env/GridWorld，并且在创建环境时应使用适当的ID。

关键字参数 max_episode_steps=300 将确保通过 gymnasium.make 实例化的 GridWorld 环境将被包装在一个 TimeLimit 包装器中（更多信息请参阅 包装器文档）。如果在当前回合中代理已达到目标 或 已执行 300 步，则将产生一个完成信号。要区分截断和终止，您可以检查 info["TimeLimit.truncated"]。

除了 id 和 entrypoint 之外，您还可以向 register 传递以下额外的关键字参数：

名称	类型	默认	描述
reward_threshold	float	None	任务被视为解决前的奖励阈值
nondeterministic	bool	False	即使在设置种子后，此环境是否仍为非确定性
max_episode_steps	int	None	一个情节可以包含的最大步数。如果不是 None ，则会添加一个 TimeLimit 包装器。
order_enforce	bool	True	是否在环境中使用 OrderEnforcing 包装器进行包装
kwargs	dict	{}	传递给环境类的默认 kwargs

这些关键字中的大多数（除了 max_episode_steps、order_enforce 和 kwargs）不会改变环境实例的行为，只是为你的环境提供一些额外的信息。注册后，我们的自定义 GridWorldEnv 环境可以通过 env = gymnasium.make('gymnasium_env/GridWorld-v0') 创建。

gymnasium_env/envs/__init__.py 应该包含：

from gymnasium_env.envs.grid_world import GridWorldEnv

如果你的环境未注册，你可以选择传递一个要导入的模块，该模块会在创建环境之前注册你的环境，如下所示 - env = gymnasium.make('module:Env-v0')，其中 module 包含注册代码。对于 GridWorld 环境，注册代码通过导入 gymnasium_env 运行，因此如果无法显式导入 gymnasium_env，你可以在创建时通过 env = gymnasium.make('gymnasium_env:gymnasium_env/GridWorld-v0') 进行注册。这在只允许将环境ID传递给第三方代码库（例如学习库）时特别有用。这使你无需编辑库的源代码即可注册你的环境。

创建一个包

最后一步是将我们的代码结构化为一个Python包。这涉及到配置 pyproject.toml。一个最小的示例如下：

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "gymnasium_env"
version = "0.0.1"
dependencies = [
  "gymnasium",
  "pygame==2.1.3",
  "pre-commit",
]

创建环境实例

现在你可以使用以下命令在本地安装你的包：

pip install -e .

你可以通过以下方式创建环境实例：

# run_gymnasium_env.py

import gymnasium
import gymnasium_env
env = gymnasium.make('gymnasium_env/GridWorld-v0')

你也可以将环境的构造函数的键值参数传递给 gymnasium.make 来自定义环境。在我们的例子中，我们可以这样做：

env = gymnasium.make('gymnasium_env/GridWorld-v0', size=10)

有时，您可能会发现跳过注册并自行调用环境的构造函数更为方便。有些人可能认为这种方法更符合Python风格，并且像这样实例化的环境也是完全没问题的（但记得也要添加包装器！）。

使用包装器

通常，我们希望使用自定义环境的多种变体，或者我们想要修改由 Gymnasium 或其他方提供的环境的行为。包装器允许我们这样做，而无需更改环境实现或添加任何样板代码。有关如何使用包装器以及实现自己的包装器的详细信息，请查看 包装器文档。在我们的示例中，观察结果不能直接用于学习代码，因为它们是字典。然而，我们实际上不需要触及我们的环境实现来解决这个问题！我们只需在环境实例之上添加一个包装器，将观察结果展平为一个单一数组：

import gymnasium
import gymnasium_env
from gymnasium.wrappers import FlattenObservation

env = gymnasium.make('gymnasium_env/GridWorld-v0')
wrapped_env = FlattenObservation(env)
print(wrapped_env.reset())     # E.g.  [3 0 3 3], {}

包装器的一大优势是它们使环境高度模块化。例如，与其将GridWorld的观察结果扁平化，你可能只想查看目标和代理的相对位置。在 ObservationWrappers 部分，我们实现了一个执行此任务的包装器。该包装器也可以在 gymnasium_env/wrappers/relative_position.py 中找到：

import gymnasium
import gymnasium_env
from gymnasium_env.wrappers import RelativePosition

env = gymnasium.make('gymnasium_env/GridWorld-v0')
wrapped_env = RelativePosition(env)
print(wrapped_env.reset())     # E.g.  [-3  3], {}