Skip to content

Commit 4e91222

Browse files
committed
init
1 parent e46d34d commit 4e91222

File tree

239 files changed

+30344
-39
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

239 files changed

+30344
-39
lines changed

CITATION.cff

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- name: "UniAD Contributors"
5+
title: "Planning-oriented Autonomous Driving"
6+
date-released: 2023-03-26
7+
url: "https://github.com/OpenDriveLab/UniAD"
8+
license: Apache-2.0

CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

README.md

Lines changed: 93 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Planning-oriented Autonomous Driving
44
</div>
55

6-
<p align="center">
6+
<!-- <p align="center">
77
<a href="https://opendrivelab.github.io/UniAD/">
88
<img alt="Project Page" src="https://img.shields.io/badge/Project%20Page-Open-yellowgreen.svg" target="_blank" />
99
</a>
@@ -13,66 +13,125 @@
1313
<a href="https://github.com/OpenDriveLab/UniAD/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">
1414
<img alt="Good first issue" src="https://img.shields.io/github/issues/OpenDriveLab/UniAD/good%20first%20issue" target="_blank" />
1515
</a>
16-
</p>
16+
</p> -->
1717

1818
<h3 align="center">
19-
<a href="https://opendrivelab.github.io/UniAD/">project page</a> |
19+
<a href="https://opendrivelab.github.io/UniAD/">Project Page</a> |
2020
<a href="https://arxiv.org/abs/2212.10156">arXiv</a> |
21-
<a href="">video</a>
21+
<a href="https://opendrivelab.com/">OpenDriveLab</a>
22+
2223
</h3>
2324

2425
https://user-images.githubusercontent.com/48089846/202974395-15fe83ac-eebb-4f38-8172-b8ca8c65127e.mp4
2526

26-
This repository will host the code of UniAD.
27-
28-
> Planning-oriented Autonomous Driving
29-
>
30-
> Yihan Hu*, Jiazhi Yang*, [Li Chen*](https://scholar.google.com/citations?user=ulZxvY0AAAAJ&hl=en&authuser=1), Keyu Li*, Chonghao Sima, Xizhou Zhu, Siqi Chai, Senyao Du, Tianwei Lin, Wenhai Wang, Lewei Lu, Xiaosong Jia, Qiang Liu, Jifeng Dai, Yu Qiao, [Hongyang Li](https://lihongyang.info/)
31-
> - CVPR 2023, award candidate
32-
> - Primary contact: Li Chen ( [email protected] )
27+
<br><br>
3328

3429
![teaser](sources/pipeline.png)
3530

36-
## Highlights
31+
## Table of Contents:
32+
1. [Highlights](#high)
33+
2. [News](#news)
34+
3. [Getting Started](#start)
35+
- [Installation](docs/INSTALL.md)
36+
- [Prepare Dataset](docs/DATA_PREP.md)
37+
- [Evaluation Example](docs/TRAIN_EVAL.md)
38+
- [GPU Requirements](docs/TRAIN_EVAL.md)
39+
- [Train/Eval](docs/TRAIN_EVAL.md)
40+
4. [Results and Models](#models)
41+
5. [TODO List](#todos)
42+
6. [License](#license)
43+
7. [Citation](#citation)
3744

38-
- :oncoming_automobile: **Planning-oriented philosophy**: UniAD is a Unified Autonomous Driving algorithm framework devised following a planning-oriented philosophy. Instead of standalone modular design and multi-task learning, perception, prediciton and planning tasks/components should opt in and be prioritized hierarchically, and we demonstrate the performance can be enhanced to a new level.
39-
- :trophy: **SOTA performance**: All tasks among UniAD achieve SOTA performance, especially prediction and planning (motion: 0.71m minADE, occ: 63.4% IoU-n., plan: 0.31% avg.Col)
45+
## Highlights <a name="high"></a>
4046

41-
## News
47+
- :oncoming_automobile: **Planning-oriented philosophy**: UniAD is a Unified Autonomous Driving algorithm framework following a planning-oriented philosophy. Instead of standalone modular design and multi-task learning, we cast a series of tasks, including perception, prediction and planning tasks hierarchically.
48+
- :trophy: **SOTA performance**: All tasks within UniAD achieve SOTA performance, especially prediction and planning (motion: 0.71m minADE, occ: 63.4% IoU, planning: 0.31% avg.Col)
4249

43-
- Code & model release: We are actively re-organizing the codebase for better readability. The estimated time is late March. Please stay tuned!
44-
- About the title: To avoid confusion about the "goal", we change the title from "Goal-oriented" to "Planning-oriented" as suggested by the reviewers. We originally use "goal" to indicate the final safe planning in an AD pipeline, rather than "goal-point" -- the destination of a sequence of actions.
45-
- [2023/03/21] :rocket::rocket: UniAD paper is accepted by CVPR 2023, as an **award candidate** (12 out of 9155 submissions and 2360 accepted papers)!
46-
- [2022/12/21] UniAD [paper](https://arxiv.org/abs/2212.10156) is available on arXiv!
50+
## News <a name="news"></a>
4751

48-
<!--
49-
## Getting started
52+
- **`Paper Title Change`**: To avoid confusion with the "goal-point" navigation in Robotics, we change the title from "Goal-oriented" to "Planning-oriented" suggested by Reviewers. Thank you!
53+
- [2023/04] **_Estimated_**. Model checkpoints release `v2.0`
54+
55+
56+
- [2023/03/29] Code & model initial release `v1.0`
57+
- [2023/03/21] :rocket::rocket: UniAD is accepted by CVPR 2023, as an **Award Candidate** (12 out of 2360 accepted papers)!
58+
- [2022/12/21] UniAD [paper](https://arxiv.org/abs/2212.10156) is available on arXiv.
59+
60+
61+
62+
<!-- ## Table of Contents:
63+
1. [Installation](docs/INSTALL.md)
64+
2. [Prepare Data](docs/DATA_PREP.md)
65+
3. [Evaluation Example](docs/TRAIN_EVAL.md#example)
66+
4. [UniAD Training](docs/TRAIN_EVAL.md#train)
67+
5. [UniAD Evaluation](docs/TRAIN_EVAL.md#eval)
68+
6. [Results and Models](#models)
69+
7. [TODO List](#todos)
70+
7. [License](#license)
71+
8. [Citing](#citation) -->
72+
73+
74+
## Getting Started <a name="start"></a>
75+
- [Installation](docs/INSTALL.md)
76+
- [Prepare Dataset](docs/DATA_PREP.md)
77+
- [Evaluation Example](docs/TRAIN_EVAL.md)
78+
- [GPU Requirements](docs/TRAIN_EVAL.md)
79+
- [Train/Eval](docs/TRAIN_EVAL.md)
80+
81+
## Results and Pre-trained Models <a name="models"></a>
82+
UniAD is trained in two stages. Pretrained checkpoints of both stages will be released and the results of each model are listed in the following tables.
83+
84+
### Stage-one: Perception training
85+
> We first train the perception modules (i.e., track and map) to obtain a stable initlization for the next stage.
5086
51-
- [Installation]()
52-
- [Dataset preparation]()
53-
- [Train and eval]()
54-
-->
87+
| Method | Encoder | Tracking<br>AMOTA | Mapping<br>IoU-lane | config | Download |
88+
| :---: | :---: | :---: | :---: | :---:|:---:|
89+
| UniAD-S | R50 | - | - | TBA | TBA |
90+
| UniAD-B | R101 | 0.390 | 0.297 | [base-stage1](projects/configs/track_map/base_stage1.py) | [base-stage1](https://github.com/OpenDriveLab/UniAD/releases/download/untagged-d7e1d5e20eded789eee9/uniad_base_track_map.pth) |
91+
| UniAD-L | V2-99 | - | - | TBA | TBA |
5592

56-
## Main results
5793

58-
Pre-trained models and results under main metrics are provided below. We refer you to the [paper](https://arxiv.org/abs/2212.10156) for more details.
94+
95+
### Stage-two: End-to-end training
96+
> We optimize all task modules together, including track, map, motion, occupancy and planning.
97+
98+
<!--
99+
Pre-trained models and results under main metrics are provided below. We refer you to the [paper](https://arxiv.org/abs/2212.10156) for more details. -->
59100

60101
| Method | Encoder | Tracking<br>AMOTA | Mapping<br>IoU-lane | Motion<br>minADE |Occupancy<br>IoU-n. | Planning<br>avg.Col. | config | Download |
61102
| :---: | :---: | :---: | :---: | :---:|:---:| :---: | :---: | :---: |
62103
| UniAD-S | R50 | 0.241 | 0.315 | 0.788 | 59.4 | 0.32 | TBA | TBA |
63-
| UniAD-M | R101 | 0.359 | 0.313 | 0.708 | 63.4 | 0.31 | TBA | TBA |
104+
| UniAD-B | R101 | 0.359 | 0.313 | 0.708 | 63.4 | 0.31 | TBA | TBA |
64105
| UniAD-L | V2-99 | 0.409 | 0.323 | 0.723 | 64.1 | 0.29 | TBA | TBA |
65106

66-
## License
107+
### Checkpoint Usage
108+
* Download the checkpoints you need into `UniAD/ckpts/` directory.
109+
* You can evaluate these checkpoints to reproduce the results, following the `evaluation` section in [TRAIN_EVAL.md](docs/TRAIN_EVAL.md).
110+
* You can also initialize your own model with the provided weights. Change the `load_from` field to `path/of/ckpt` in the config and follow the `train` section in [TRAIN_EVAL.md](docs/TRAIN_EVAL.md) to start training.
111+
112+
113+
### Model Structure
114+
The overall pipeline of UniAD is controlled by [uniad_e2e.py](projects/mmdet3d_plugin/uniad/detectors/uniad_e2e.py) which coordinates all the task modules in `UniAD/projects/mmdet3d_plugin/uniad/dense_heads`. If you are interested in the implementation of a specific task module, please refer to its corresponding file, e.g., [motion_head](projects/mmdet3d_plugin/uniad/dense_heads/motion_head.py).
115+
116+
## TODO List <a name="todos"></a>
117+
- [ ] Base-model configs & checkpoints [Est. 2023/04]
118+
- [ ] Separating BEV encoder and tracking module [Est. 2023/04]
119+
- [ ] Support larger batch size [Est. 2023/04]
120+
- [ ] (Long-term) Improve flexibility for future extensions
121+
- [ ] All configs & checkpoints
122+
- [x] Code initialization
67123

68-
All assets and code are under the [Apache 2.0 license](https://github.com/OpenDriveLab/UniAD/blob/master/LICENSE) unless specified otherwise.
69124

70-
## Citation
125+
## License <a name="license"></a>
126+
127+
All assets and code are under the [Apache 2.0 license](./LICENSE) unless specified otherwise.
128+
129+
## Citation <a name="citation"></a>
71130

72131
Please consider citing our paper if the project helps your research with the following BibTex:
73132

74133
```bibtex
75-
@inproceedings{uniad,
134+
@inproceedings{hu2023_uniad,
76135
title={Planning-oriented Autonomous Driving},
77136
author={Yihan Hu and Jiazhi Yang and Li Chen and Keyu Li and Chonghao Sima and Xizhou Zhu and Siqi Chai and Senyao Du and Tianwei Lin and Wenhai Wang and Lewei Lu and Xiaosong Jia and Qiang Liu and Jifeng Dai and Yu Qiao and Hongyang Li},
78137
booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
@@ -82,10 +141,9 @@ Please consider citing our paper if the project helps your research with the fol
82141
## Related resources
83142

84143
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
85-
86-
- [mmdet3d](https://github.com/open-mmlab/mmdetection3d)
87144
- [BEVFormer](https://github.com/fundamentalvision/BEVFormer) (:rocket:Ours!)
88145
- [ST-P3](https://github.com/OpenPerceptionX/ST-P3) (:rocket:Ours!)
146+
- [mmdet3d](https://github.com/open-mmlab/mmdetection3d)
89147
- [FIERY](https://github.com/wayveai/fiery)
90148
- [MOTR](https://github.com/megvii-research/MOTR)
91-
- [BEVerse](https://github.com/zhangyp15/BEVerse)
149+
- [BEVerse](https://github.com/zhangyp15/BEVerse)

docs/DATA_PREP.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,66 @@
1-
# Dataset Preparation
1+
2+
3+
# NuScenes
4+
Download nuScenes V1.0 full dataset data, CAN bus and map(v1.3) extensions [HERE](https://www.nuscenes.org/download), following the steps below to prepare the data.
5+
6+
7+
**Download nuScenes, CAN_bus and Map extensions**
8+
```shell
9+
cd UniAD
10+
mkdir data
11+
# Download nuScenes V1.0 full dataset data directly to (or soft link to) UniAD/data/
12+
# Download CAN_bus and Map(v1.3) extensions directly to (or soft link to) UniAD/data/nuscenes/
13+
```
14+
15+
**Prepare UniAD data infos**
16+
17+
*Option1: We have already prepared the off-the-shelf data infos for you:*
18+
```shell
19+
cd UniAD/data
20+
mkdir infos
21+
cd infos
22+
wget https://github.com/OpenDriveLab/UniAD/releases/download/untagged-d7e1d5e20eded789eee9/nuscenes_infos_temporal_train.pkl # train_infos
23+
wget https://github.com/OpenDriveLab/UniAD/releases/download/untagged-d7e1d5e20eded789eee9/nuscenes_infos_temporal_val.pkl # val_infos
24+
```
25+
26+
27+
*Option2: You can also generate the data infos by yourself:*
28+
```shell
29+
cd UniAD/data
30+
mkdir infos
31+
./tools/uniad_create_data.sh
32+
# This will generate nuscenes_infos_temporal_{train,val}.pkl
33+
```
34+
35+
**Prepare Motion Anchors**
36+
```shell
37+
cd UniAD/data
38+
mkdir others
39+
cd others
40+
wget https://github.com/OpenDriveLab/UniAD/releases/download/untagged-d7e1d5e20eded789eee9/motion_anchor_infos_mode6.pkl
41+
```
42+
43+
**The Overall Structure**
44+
45+
*Please make sure the data structure in UniAD/data/ is as follows:*
46+
```
47+
UniAD
48+
├── projects/
49+
├── tools/
50+
├── configs/
51+
├── ckpts/
52+
│ ├── uniad_base_track_map.pth
53+
├── data/
54+
│ ├── nuscenes/
55+
│ │ ├── can_bus/
56+
│ │ ├── maps/
57+
│ │ ├── samples/
58+
│ │ ├── sweeps/
59+
│ │ ├── v1.0-test/
60+
│ │ ├── v1.0-trainval/
61+
│ ├── infos/
62+
│ │ ├── nuscenes_infos_temporal_train.pkl
63+
│ │ ├── nuscenes_infos_temporal_val.pkl
64+
│ ├── others/
65+
│ │ ├── motion_anchor_infos_mode6.pkl
66+
```

0 commit comments

Comments
 (0)