tuPlan Garage 项目使用教程
1. 项目目录结构及介绍
tuPlan Garage 项目的目录结构如下:
tuplan_garage/
├── assets/
├── scripts/
│ ├── training/
│ └── simulation/
├── tuplan_garage/
│ ├── flake8/
│ ├── gitignore/
│ ├── isort.cfg/
│ ├── pre-commit-config.yaml/
│ ├── CONTRIBUTING.md
│ ├── LICENSE
│ ├── README.md
│ ├── requirements.txt
│ └── setup.py
目录介绍:
- assets/: 存放项目相关的资源文件,如图片、视频等。
- scripts/: 包含项目的脚本文件,分为
training/
和simulation/
两个子目录,分别用于训练和仿真。 - tuplan_garage/: 项目的主要代码目录,包含配置文件、依赖文件、贡献指南、许可证、README文件等。
2. 项目的启动文件介绍
tuPlan Garage 项目的启动文件主要位于 scripts/
目录下。以下是一些关键的启动文件:
- scripts/training/: 包含用于训练模型的脚本文件。
- scripts/simulation/: 包含用于仿真和评估的脚本文件。
示例启动命令:
python $NUPLAN_DEVKIT_ROOT/nuplan/planning/script/run_simulation.py \
+simulation=closed_loop_nonreactive_agents \
planner=pdm_closed_planner \
scenario_filter=val14_split \
scenario_builder=nuplan \
hydra.searchpath="[pkg://tuplan_garage.planning.script.config.common, pkg://tuplan_garage.planning.script.config.simulation, pkg://nuplan.planning.script.config.common, pkg://nuplan.planning.script.experiments]"
3. 项目的配置文件介绍
tuPlan Garage 项目的配置文件主要位于 tuplan_garage/
目录下。以下是一些关键的配置文件:
- flake8/: 包含 Flake8 代码风格检查的配置文件。
- gitignore/: 包含 Git 忽略文件的配置。
- isort.cfg/: 包含 isort 代码排序工具的配置文件。
- pre-commit-config.yaml/: 包含 pre-commit 钩子的配置文件。
- CONTRIBUTING.md: 贡献指南文件。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍和使用说明文件。
- requirements.txt: 项目依赖文件。
- setup.py: 项目安装脚本。
配置文件示例:
# pre-commit-config.yaml
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.4.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
通过以上配置文件,可以确保项目的代码风格一致性、依赖管理以及项目的基本信息。