---

传感器数据发布

重要提示：文件结构已更改！请查看 数据集设置 页面，了解更新后的文件结构。

• nuPlan v1.1 数据集的传感器数据现已发布。请从 nuPlan 页面 下载最新数据集。
• 由于传感器数据体积较大，将分阶段逐步发布。首批发布的传感器数据对应于 nuPlan mini 数据子集。
• 我们提供了一个简短的传感器数据使用教程 nuplan_sensor_data_tutorial.ipynb，帮助您快速上手。

---

规划挑战赛

重要提示：nuPlan 提交所使用的基础 Docker 镜像已更新。请使用新的 Dockerfile.submission 重新构建您的提交容器。

• 规划挑战赛自即日起将采用开发套件版本 1.2。由版本 1.1 生成的提交应保持兼容性。不过，建议您通过参与热身阶段来再次确认。
• 该挑战赛将在 CVPR 2023 的 端到端自动驾驶 研讨会上进行展示。
• nuPlan 数据集 v1.1 已发布。请从 nuPlan 页面 下载最新数据集。

---

更新日志

• 2023年5月11日
  • 开发套件 v1.2.2：更新了提交用的基础镜像。
• 2023年5月9日
  • 开发套件 v1.2.1：更新了竞赛日期。提交截止日期延长至2023年5月26日。
• 2023年4月25日
  • 开发套件 v1.2：nuPlan 传感器数据正式发布！优化了特征缓存和 nuBoard 控制台功能。调整了数据集文件结构，新接口支持传感器数据的获取。固定了 hydra、numpy 和 sqlalchemy 等多个软件包版本。
• 2023年1月20日
  • 开发套件 v1.1：正式发布 nuPlan 挑战赛。优化了训练缓存，改进了仿真功能，并升级至 shapely 2.0。
• 2022年10月13日
  • 数据集 v1.1：完整 nuPlan 数据集——优化了路线规划、交通信号灯状态、任务目标等！
  • 开发套件 v1.0：适配 nuplan-v1.1 数据集，改进了评估指标，修复了路线规划问题，并完善了文档和 IDMPlanner。
• 2022年9月9日
  • 开发套件 v0.6：优化了智能代理，改进了 nuBoard 控制台，提升了评估指标，部署了提交流程并完善了文档。
• 2022年8月26日
  • 开发套件 v0.5：新增地图功能，改进了仿真效果，实现了基于智能代理的开环检测和 iLQR 跟踪器，同时提升了评估指标和文档质量。
• 2022年8月5日
  • 开发套件 v0.4：优化了数据库性能，抑制了 PYGEOS 警告信息，提升了评估指标，并增加了用于训练的场景筛选功能。
• 2022年7月15日
  • 开发套件 v0.3：对开发套件进行了多项更新，包括但不限于：nuBoard 控制台升级、降低缓存和训练过程中的内存占用、新增地图 API 以及提升仿真和评估指标的运行效率。
• 2022年6月10日
  • 数据集 v1.0：完整 nuPlan 数据集发布，包含来自拉斯维加斯、匹兹堡、波士顿和新加坡四个城市超过 1,300 小时的驾驶数据（15,000 多条日志）。
  • 开发套件 v0.2：对开发套件进行了多处更新，涵盖了整个框架的改进（规划模型、训练、仿真、评估指标、控制台、教程等）。
• 2021年12月19日
  • 数据集 v0.2：修复了预告版 nuPlan 数据集中的 bug。
• 2021年12月10日
  • 数据集 v0.1：首次发布预告版 nuPlan 数据集，包含来自拉斯维加斯超过 200 小时的驾驶数据（350 多条日志）。
  • 开发套件 v0.1：首次发布 nuPlan 开发套件。

---

开发套件与数据集设置

请参阅 安装指南 以获取详细的开发套件安装说明。

请参阅 数据集设置指南 以获取详细的数据集下载和设置说明。

---

入门指南

对于有兴趣参与 Motional^TM nuPlan^TM 规划竞赛的人员，请参阅竞赛 landing [页面](https://nuplan-devkit.readthedocs.io/en/latest/)。

请按照以下步骤熟悉 nuPlan 数据集：

• 了解 nuPlan 的主要 功能 和 数据集说明。

• 按照上述说明设置开发工具包和数据集。

• 浏览此文件夹中的教程，或使用 jupyter notebook ~/nuplan-devkit/tutorials/<filename>.ipynb 命令自行运行，并将 <filename> 替换为相应教程的名称。目前提供以下教程：

  • nuplan_framework.ipynb：适合希望直接深入机器学习规划的用户的主要教程。该教程介绍了如何 1) 训练一个机器学习规划器，2) 进行仿真，3) 评估性能，以及 4) 可视化结果。
  • nuplan_scenario_visualization.ipynb：用于可视化 nuPlan 数据集中包含的各种场景类型（例如无保护左转、变道、与行人交互等）的教程。
  • nuplan_planner_tutorial.ipynb：介绍如何在 nuPlan 框架内从头开始开发并仿真规划器的教程。
  • nuplan_advanced_model_training.ipynb：本笔记本将详细介绍在 NuPlan 框架中训练规划模型的相关细节。它更深入地探讨了 NuPlan 架构，并涵盖了可用于在 NuPlan 框架中构建自定义模型的扩展点。

• 熟悉 nuPlan CLI 工具，该工具可通过使用 pip 安装开发工具包时一并安装（可编辑版和不可编辑版均可），运行以下命令即可查看帮助信息：

  nuplan_cli --help
  nuplan_cli COMMAND --help
  

• 阅读nuPlan 论文，以深入了解该数据集的细节。

---

性能调优指南

训练配置对于确保系统达到预期性能至关重要，例如预处理开销、训练速度和数值稳定性。如果您遇到与上述方面相关的问题，请参考性能调优指南，以寻找可能的解决方案。

---

开发工具包结构

我们的代码组织如下：

nuplan_devkit
├── ci              - 持续集成代码 - 对普通用户不重要。
├── docs            - 仓库和数据集的 README 文件及其他文档。
├── nuplan          - 主要源代码目录。
│   ├── common      - “数据库”和“规划”共享的代码。
│   ├── database    - 用于加载和渲染 nuPlan 数据集及地图的核心开发工具包。
│   ├── planning    - 用于仿真、训练和评估的独立规划框架。
│   ├── submission  - 用于规划挑战赛的提交引擎。
│   └── cli         - nuPlan 数据库的命令行工具。
└── tutorials       - 交互式教程，详见“入门指南”。

---

引用

引用nuPlan时，请使用以下引用格式：

@INPROCEEDINGS{nuplan, 
  title={NuPlan: 一种面向自动驾驶车辆的闭环基于机器学习的规划基准测试},
  author={H. Caesar, J. Kabzan, K. Tan 等,},
  booktitle={CVPR ADP3 workshop},
  year=2021
}

nuPlan-devkit 快速上手指南

nuPlan 是全球首个自动驾驶规划基准测试平台，由 Motional 开源。本指南帮助开发者快速搭建环境并运行基础示例。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux (推荐 Ubuntu 20.04/22.04) 或 macOS。Windows 用户建议使用 WSL2 或 Docker。
• Python 版本: Python 3.9 (严格依赖，其他版本可能导致兼容性问题)。
• 包管理工具: pip 和 virtualenv (或 conda)。
• 硬件建议: 若需训练模型或进行大规模仿真，建议配备 NVIDIA GPU 及对应的 CUDA 驱动。

注意：nuPlan 数据集较大，请确保有足够的磁盘空间（建议预留 50GB+ 用于数据集和缓存）。

2. 安装步骤

2.1 创建虚拟环境

推荐使用 venv 或 conda 隔离环境，避免依赖冲突。

# 使用 venv
python3.9 -m venv nuplan-env
source nuplan-env/bin/activate

# 或者使用 conda
conda create -n nuplan-env python=3.9
conda activate nuplan-env

2.2 克隆代码库

从 GitHub 获取最新源码：

git clone https://github.com/motional/nuplan-devkit.git
cd nuplan-devkit

2.3 安装依赖

安装开发套件及其依赖项。国内用户若遇到下载慢的问题，可临时指定清华或阿里镜像源加速。

# 标准安装
pip install -e .

# 【国内加速推荐】使用清华源安装
pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple

2.4 数据集配置

nuPlan 的核心是数据集。您需要单独下载数据并配置路径。

1. 下载数据: 访问 nuPlan 下载页面 注册并下载数据集（包含地图、日志和传感器数据）。
2. 设置环境变量: 下载完成后，将数据根目录路径设置为环境变量 NUPLAN_DATA_ROOT。

# 假设数据下载到 /data/nuplan
export NUPLAN_DATA_ROOT=/data/nuplan

# 建议将上述命令添加到 ~/.bashrc 或 ~/.zshrc 中永久生效
echo "export NUPLAN_DATA_ROOT=/data/nuplan" >> ~/.bashrc
source ~/.bashrc

重要提示: v1.1 版本后文件结构有所变更，请务必参照官方 Dataset Setup 文档确认目录结构正确。

3. 基本使用

安装完成后，您可以通过命令行工具或 Jupyter Notebook 快速体验。

3.1 验证 CLI 工具

检查命令行接口是否安装成功：

nuplan_cli --help

3.2 运行官方教程 (推荐)

nuPlan 提供了详细的 Jupyter Notebook 教程，涵盖从数据加载、规划器训练到仿真评估的全流程。

启动 Jupyter Notebook 并打开主框架教程：

jupyter notebook tutorials/nuplan_framework.ipynb

该教程 (nuplan_framework.ipynb) 将引导您完成以下核心步骤：

1. 训练: 训练一个基础的机器学习规划器。
2. 仿真: 在仿真环境中运行该规划器。
3. 评估: 计算性能指标。
4. 可视化: 查看规划轨迹和场景结果。

3.3 其他实用教程

根据需求，您还可以运行以下特定教程：

• 场景可视化: 浏览数据集中的不同驾驶场景（如无保护左转、行人交互等）。

  jupyter notebook tutorials/nuplan_scenario_visualization.ipynb
  

• 从零开发规划器: 学习如何在 nuPlan 框架内从头构建和模拟一个规划器。

  jupyter notebook tutorials/nuplan_planner_tutorial.ipynb
  

• 高级模型训练: 深入架构细节，定制自定义模型。

  jupyter notebook tutorials/nuplan_advanced_model_training.ipynb
  

3.4 传感器数据体验

如果您已下载传感器数据（Sensor Data），可运行专用教程：

jupyter notebook tutorials/nuplan_sensor_data_tutorial.ipynb

---

更多详细文档请参考 nuPlan 官方文档。