Skip to content

Commit 016dce0

Browse files
committed
📃 docs: update readme for v1.0
1 parent d5dddae commit 016dce0

File tree

6 files changed

+53
-26
lines changed

6 files changed

+53
-26
lines changed

README.md

+38-15
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,44 @@
3131
-->
3232

3333
------
34-
### 💡 Notice
35-
DriveArena V1.0 is currently under active development and will be open-sourced soon.
3634

37-
**If you want to get informed once the code is released, please fill out this <a href="https://forms.gle/AYtQdiZEvCTr2T56A">Google form</a>.**
3835

3936
### :new: Updates
4037

38+
`[2024-09-05]:` **We are happy to announce the release of DriveArena V1.0 🎊🎊**
39+
4140
`[2024-08-02]:` The paper can be accessed at [arxiv](https://arxiv.org/abs/2408.00415).
4241

4342
`[2024-07-30]:` We've released the [project page](https://pjlab-adg.github.io/DriveArena/) of DriveArena!
4443

4544
------
4645

47-
## 🤩 Run DriveArena Demo
46+
47+
## Table of Contents:
48+
- [Table of Contents:](#table-of-contents)
49+
- [🤩 Running DriveArena](#-running-drivearena)
50+
- [:fire: Highlights](#fire-highlights)
51+
- [🏁 Leaderboard of Driving Agents](#-leaderboard-of-driving-agents)
52+
- [1. Open-loop Evaluation Leaderboard](#1-open-loop-evaluation-leaderboard)
53+
- [2. Closed-loop Evaluation Leaderboard](#2-closed-loop-evaluation-leaderboard)
54+
- [📌 Roadmap](#-roadmap)
55+
- [Acknowledgments](#acknowledgments)
56+
- [📝 License](#-license)
57+
- [🔖 Citation](#-citation)
58+
59+
60+
61+
62+
## 🤩 Running DriveArena
4863
**To run the closed-loop / open-loop simulation, please refer to the [[Documentation](docs/RUN_SIMULATION.md)|[中文说明](docs/RUN_SIMULATION_CN.md)].**
4964

65+
Just for three steps, and you will be able to launch DriveArena as the window below:
66+
67+
68+
<div align="center">
69+
<img width=800px src="assets/simulation.png">
70+
</div>
71+
5072
## :fire: Highlights
5173

5274
<b> DriveArena </b> is a simulation platform that can
@@ -112,7 +134,7 @@ We provide a leaderboard to present the driving performance evaluation of drivin
112134
</tr>
113135
</table>
114136

115-
### 2. Closed-loop Evaluation Leaderboard with DriveArena
137+
### 2. Closed-loop Evaluation Leaderboard
116138

117139
<table>
118140
<tr style="background-color: #C7C7C7; color: white;">
@@ -157,15 +179,16 @@ We provide a leaderboard to present the driving performance evaluation of drivin
157179
## 📌 Roadmap
158180

159181
- [x] Demo Website Release
160-
- [ ] V1.0 Release
161-
- [ ] Traffic Manager Code
162-
- [ ] World Dreamer
163-
- [ ] Inference Code
164-
- [ ] Training Code
165-
- [ ] Pretrained Weights
182+
- [x] V1.0 Release
183+
- [x] Traffic Manager Code
184+
- [x] World Dreamer
185+
- [x] Inference Code
186+
- [x] Training Code
187+
- [x] Pretrained Weights
166188
- [ ] Evaluation Code
189+
- [ ] Development Turtorial
167190
- [ ] Driving Agent Support
168-
- [ ] UniAD
191+
- [x] UniAD
169192
- [ ] VAD
170193
- [ ] LeapAD
171194
- [ ] Video Autoregression Dreamer
@@ -175,19 +198,19 @@ We provide a leaderboard to present the driving performance evaluation of drivin
175198

176199
We utilized the following repos during development:
177200

178-
* [LimSim++](https://github.com/PJLab-ADG/LimSim/tree/LimSim_plus)
201+
* [LimSim (Ours!)](https://github.com/PJLab-ADG/LimSim/tree/LimSim_plus)
179202
* [MagicDrive](https://github.com/cure-lab/MagicDrive)
180203
* [UniAD](https://github.com/OpenDriveLab/UniAD)
181204

182205
Thanks for their Awesome open-sourced work!
183206

184207
<!-- LICENSE -->
185-
## License
208+
## 📝 License
186209

187210
Distributed under the [Apache 2.0 license](./LICENSE).
188211

189212
<!-- CONTACT -->
190-
## Citation
213+
## 🔖 Citation
191214

192215
If you find our paper and codes useful, please kindly cite us via:
193216

config.yaml TrafficManager/config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Server Configuration
22
servers:
3-
diffusion: "http://127.0.0.1:11000/"
4-
driver: "http://127.0.0.1:11001/"
3+
diffusion: "http://127.0.0.1:11002/"
4+
driver: "http://127.0.0.1:11003/"
55

66
# Simulation Configuration
77
simulation:

TrafficManager/sim_manager.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ def cleanup(self):
296296

297297

298298
def main():
299-
sim_manager = SimulationManager('config.yaml')
299+
sim_manager = SimulationManager('./TrafficManager/config.yaml')
300300
sim_manager.run_simulation()
301301

302302

assets/simulation.png

-48.3 KB
Loading

docs/RUN_SIMULATION.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# 🤩 Run DriveArena Demo!
22

3-
The communication between TrafficManager, WorldDreamer and DrivingAgent is based on **FastAPI**. **WorldDreamer** and **DrivingAgent** can be run on the **remote server**, while **TrafficManager** needs to be run on **a local machine with a screen**.
3+
The communication between TrafficManager, WorldDreamer and DrivingAgent is based on **FastAPI**.
44

5-
## Launch WorldDreamer Service
5+
⚠️⚠️**WorldDreamer** and **DrivingAgent** can be run on the **remote server**, while **TrafficManager** needs to be run on **a local machine with a screen**.
6+
7+
## Step 1: Launch WorldDreamer Service
68
Please follow the [README.md](../WorldDreamer/README.md) to prepare the environment and download the weights.
79

810
Then you can run the following code.
911
```shell
1012
cd WorldDreamer && python tools/dreamer_fast_api.py --resume=path/to/your/weight
1113
```
1214

13-
## Launch DrivingAgent Service
15+
## Step 2: Launch DrivingAgent Service
1416
Please follow the [README.md](../DrivingAgents/UniAD/README.md) to prepare the environment and download the weights.
1517

1618
```shell
1719
cd DrivingAgents/UniAD && python demo/fast_api_uniad.py
1820
```
1921

20-
## Launch TrafficManager and Start Simulation
22+
## Step 3: Launch TrafficManager and Start Simulation
2123
Please follow the [README.md](../TrafficManager/README.md) to start the simulation.
2224

2325
If everything is all right, you can see a window like this!

docs/RUN_SIMULATION_CN.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# 🤩 运行 DriveArena 模拟!
22

3-
TrafficManager、WorldDreamer 和 DrivingAgent 之间的通信基于 **FastAPI。WorldDreamer****DrivingAgent** 可以在**远程服务器**上运行,而 **TrafficManager** 需要在**带有显示器的本地机器**上运行
3+
TrafficManager、WorldDreamer 和 DrivingAgent 之间的通信基于 **FastAPI**
44

5-
## 启动 WorldDreamer 服务
5+
⚠️⚠️**WorldDreamer****DrivingAgent** 可以在**远程服务器**上运行,而 **TrafficManager** 需要在**带有显示器的本地机器**上运行。
6+
7+
## 步骤一:启动 WorldDreamer 服务
68

79
请按照 [README.md](../WorldDreamer/README.md) 准备环境并下载权重。
810

@@ -11,15 +13,15 @@ TrafficManager、WorldDreamer 和 DrivingAgent 之间的通信基于 **FastAPI
1113
cd WorldDreamer && python tools/dreamer_fast_api.py --resume=path/to/your/weight
1214
```
1315

14-
## 启动 DrivingAgent 服务
16+
## 步骤二:启动 DrivingAgent 服务
1517

1618
请按照 [README.md](../DrivingAgents/UniAD/README_CN.md) 准备环境并下载权重。
1719

1820
```shell
1921
cd DrivingAgents/UniAD && python demo/fast_api_uniad.py
2022
```
2123

22-
## 启动 TrafficManager 并开始模拟
24+
## 步骤三:启动 TrafficManager 并开始模拟
2325
请按照 [README.md](../TrafficManager/README.md) 启动模拟。
2426

2527
如果一切顺利,你将看到一个类似这样的窗口!

0 commit comments

Comments
 (0)