The Arcade Learning Environment 使用与技术文档

1. 安装指南

Python 安装

首先，确保您的系统中安装了最新版本的 pip。然后，通过以下命令安装 ale-py 包：

pip install ale-py

Gymnasium 安装

为了与 Gymnasium 集成，可以使用以下命令安装必要的模块和 ROMs：

pip install "gymnasium[atari]"

C++ 安装

以下指令假设您已经安装了有效的 C++17 编译器和 vcpkg。

使用 CMake 作为首选工具，您可以直接在任何 CMake 项目中使用 ALE。要编译和安装 ALE，您可以运行以下命令：

mkdir build && cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
cmake --build . --target install

您可以使用可选标志 -DSDL_SUPPORT=ON/OFF 来切换 SDL 支持（默认关闭），-DBUILD_CPP_LIB=ON/OFF 来构建 ale-lib C++ 目标（默认开启），以及 -DBUILD_PYTHON_LIB=ON/OFF 来构建 pybind11 包装器（默认开启）。

最后，在您的 CMake 项目中，可以这样链接 ALE：

find_package(ale REQUIRED)
target_link_libraries(YourTarget ale::ale-lib)

2. 项目使用说明

Python 使用

在 Python 项目中导入 ALE，并提供直接接口与 Stella 交互：

from ale_py import ALEInterface, roms

ale = ALEInterface()
ale.loadROM(roms.get_rom_path("breakout"))
ale.reset_game()

reward = ale.act(0)  # 执行空操作
screen_obs = ale.getScreenRGB()

Gymnasium 使用

在 Gymnasium 中使用 ALE，首先注册环境，然后创建环境实例：

import gymnasium as gym
import ale_py

gym.register_envs(ale_py)  # 对 IDE 有帮助，但不是必须的

env = gym.make('ALE/Breakout-v5', render_mode="human")  # 在训练时移除 render_mode
obs, info = env.reset()
episode_over = False
while not episode_over:
    action = policy(obs)  # 实现策略 - 使用 `env.action_space.sample()` 作为随机策略
    obs, reward, terminated, truncated, info = env.step(action)

    episode_over = terminated or truncated
env.close()

对于连续动作，可以简单修改 gym.make 调用：

env = gym.make('ALE/Breakout-v5', continuous=True, render_mode="human")

C++ 使用

在 C++ 项目中使用 ALE，您需要链接到 ale-lib：

#include <ale_interface.hpp>

ALEInterface ale;
ale.loadROM("path/to/rom");

// 更多操作...

3. 项目 API 使用文档

请参考项目官方文档和源代码仓库的 Wiki 部分，以获取详细的 API 使用文档。

4. 项目安装方式

安装方式已在“安装指南”部分详细描述。您可以选择 Python、Gymnasium 或 C++ 的方式来安装和使用 ALE。请根据您的具体需求选择合适的安装方法。