hands-on-modern-rl

环境要求

• Node.js >= 18.0.0（运行文档站）
• npm（运行文档站）
• Python（运行课程代码，README 未指定最低版本）
• 部分章节可能需要额外系统库、GPU 支持或模型下载

安装与启动步骤

1. 1克隆课程仓库

   把项目克隆到本地并进入目录，后续所有命令都在仓库根目录执行。

   git clone https://github.com/walkinglabs/hands-on-modern-rl.git
   cd hands-on-modern-rl

   复制

2. 2安装文档站依赖

   在仓库根目录用 npm 安装 VitePress 文档站所需依赖。

   npm install

   复制

3. 3启动本地文档站

   启动开发服务器后，终端会输出本地访问地址，通常是 http://localhost:5173。

   npm run dev

   复制

4. 4创建 Python 环境

   进入 code 目录，创建并激活虚拟环境，避免污染全局 Python。

   cd code
   python -m venv .venv
   source .venv/bin/activate

   复制

5. 5安装课程依赖

   安装 code 目录下 requirements.txt 中的全部依赖，体量可能较大。

   pip install -r requirements.txt

   复制

6. 6安装章节依赖

   若不想装全量依赖，可只安装第 01 章专用依赖文件，适合更轻量的安装。

   pip install -r chapter01_cartpole/requirements.txt

   复制

7. 7运行第01章示例

   运行 CartPole 的 PPO 示例脚本，这是 README 建议的第一个上手示例。

   python chapter01_cartpole/1-ppo_cartpole.py

   复制

如何确认成功

浏览器打开终端显示的 VitePress 地址（通常 http://localhost:5173）能看到文档站即为成功。

常见问题

注意事项

• README 未指定 Python 最低版本，运行前请自行确认环境兼容。
• 涉及 LLM、VLM 或重型模拟器的章节可能需要 GPU、模型下载和额外系统库。
• 课程代码按章节组织在 code 目录下，README 建议从 Chapter 01 开始。
• 项目采用 CC BY-NC-SA 4.0 许可证，使用时注意授权范围。