Skip to content

Commit 6b7ea56

Browse files
committed
update docs
1 parent 838388d commit 6b7ea56

2 files changed

Lines changed: 28 additions & 57 deletions

File tree

README.md

Lines changed: 21 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
- [SimEngine - Photorealistic Closed-Loop Simulation](#simengine---photorealistic-closed-loop-simulation)
4141
- [AlgEngine - End-to-End Model Training \& Fine-Tuning](#algengine---end-to-end-model-training--fine-tuning)
4242
- [RenderEngine - Multi-Traversal Scene Reconstruction](#renderengine---multi-traversal-scene-reconstruction)
43-
- [FAQ](#faq)
4443
- [Citation](#citation)
4544
- [Contributing](#contributing)
4645
- [License](#license)
@@ -57,10 +56,8 @@
5756

5857

5958
## News
60-
61-
- **[2026/04/08]** Official code repository established. Data publication under preparation.
6259
- **[2026/04/09]** Official dataset released. See [OpenDriveLab/WorldEngine](https://huggingface.co/datasets/OpenDriveLab/WorldEngine) or [OpenDriveLab/WorldEngine (ModelScope)](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine)
63-
60+
- **[2026/04/10]** Official code repository established.
6461

6562

6663
## Benchmark
@@ -136,11 +133,10 @@ WorldEngine consists of two tightly coupled subsystems:
136133
- [x] Multi-GPU distributed simulation and training
137134
- [x] Rare case extraction and fine-tuning pipeline
138135
- [x] Comprehensive documentation and usage guides
136+
- [x] Hugging Face / ModelScope dataset
139137
- [ ] Open-source release (code, data, pre-trained models)
140138
- [ ] arXiv preprint
141-
- [ ] Hugging Face / ModelScope dataset and model hosting
142139
- [ ] Demo webpage with interactive visualization
143-
- [ ] Additional model architectures (UniAD, HydraMDP baselines)
144140
- [ ] Behavior World Model integration
145141

146142

@@ -207,7 +203,7 @@ Learn how to run simulations, generate rollouts, and test models:
207203

208204
Learn how to train models, extract rare cases, and fine-tune:
209205

210-
- **Training from scratch** (VADv2, UniAD, HydraMDP)
206+
- **Training from scratch**
211207
- **Open-loop evaluation** on test sets
212208
- **Rare case extraction** from evaluation failures
213209
- **RL-based fine-tuning** on long-tail scenarios
@@ -226,50 +222,6 @@ WorldEngine's simulation environments are powered by 3D Gaussian Splatting (MTGS
226222
**[MTGS Repository](https://github.com/OpenDriveLab/MTGS)**
227223

228224

229-
## FAQ
230-
231-
<details>
232-
<summary><b>Q1: Do I need both conda environments?</b></summary>
233-
234-
**A:** It depends on your use case:
235-
- **For simulation only:** Install `simengine` environment
236-
- **For training only:** Install `algengine` environment
237-
- **For complete pipeline:** Install both environments
238-
239-
The two environments are needed because SimEngine requires Python 3.9 (for tiny-cuda-nn) while AlgEngine requires Python 3.8 (for MMCV 1.6.2).
240-
</details>
241-
242-
<details>
243-
<summary><b>Q2: Where can I download the data and models?</b></summary>
244-
245-
**A:** Datasets and pre-trained models will be available on:
246-
- **Hugging Face:** `OpenDriveLab/WorldEngine-Data` and `OpenDriveLab/WorldEngine-Models` (URLs coming soon)
247-
- **ModelScope:** For users in China (URLs coming soon)
248-
249-
Check our [News section](#news) for download links when available.
250-
</details>
251-
252-
<details>
253-
<summary><b>Q3: What's the difference between NR and R modes?</b></summary>
254-
255-
**A:** These are reactive modes for other agents in simulation:
256-
- **NR (Non-Reactive):** Other agents replay their logged trajectories (default, easier)
257-
- **R (Reactive):** Other agents use IDM policy to react to ego vehicle (harder, more realistic)
258-
259-
Use NR for initial testing, R for robustness evaluation.
260-
</details>
261-
262-
<details>
263-
<summary><b>Q4: How do I report bugs or request features?</b></summary>
264-
265-
**A:**
266-
- **Bugs:** Open an [Issue](https://github.com/OpenDriveLab/WorldEngine/issues)
267-
- **Features:** Start a [Discussion](https://github.com/OpenDriveLab/WorldEngine/discussions)
268-
- **Questions:** Check [documentation](docs/) first, then ask in Discussions
269-
270-
</details>
271-
272-
273225
## Citation
274226

275227
If any parts of our work help your research, please consider citing us and giving a star to our repository:
@@ -288,14 +240,30 @@ If you use the Render Assets (MTGS), please also cite:
288240
year={2025}
289241
}
290242
```
243+
If you use the augmented scenarios data, please cite as well:
244+
```bibtex
245+
@inproceedings{zhou2025nexus,
246+
title={Decoupled Diffusion Sparks Adaptive Scene Generation},
247+
author={Zhou, Yunsong and Ye, Naisheng and Ljungbergh, William and Li, Tianyu and Yang, Jiazhi and Yang, Zetong and Zhu, Hongzi and Petersson, Christoffer and Li, Hongyang},
248+
booktitle={ICCV},
249+
year={2025}
250+
}
251+
```
252+
```bibtex
253+
@article{li2025optimization,
254+
title={Optimization-Guided Diffusion for Interactive Scene Generation},
255+
author={Li, Shihao and Ye, Naisheng and Li, Tianyu and Chitta, Kashyap and An, Tuo and Su, Peng and Wang, Boyang and Liu, Haiou and Lv, Chen and Li, Hongyang},
256+
journal={arXiv preprint arXiv:2512.07661},
257+
year={2025}
258+
}
259+
```
291260

292261

293262
## Contributing
294263

295264
We welcome contributions from the community! Whether you want to:
296265

297266
- **Report bugs** - Open an [Issue](https://github.com/OpenDriveLab/WorldEngine/issues)
298-
- **Suggest features** - Start a [Discussion](https://github.com/OpenDriveLab/WorldEngine/discussions)
299267
- **Improve documentation** - Submit a [Pull Request](https://github.com/OpenDriveLab/WorldEngine/pulls)
300268
- **Contribute code** - Fork, develop, and submit a PR
301269

@@ -304,7 +272,6 @@ Please read our contributing guidelines before submitting PRs.
304272
**For questions:**
305273
1. Check the [documentation](docs/) first
306274
2. Search existing [Issues](https://github.com/OpenDriveLab/WorldEngine/issues)
307-
3. Ask in [Discussions](https://github.com/OpenDriveLab/WorldEngine/discussions)
308275

309276

310277
## License
@@ -338,6 +305,7 @@ We acknowledge all the open-source contributors for the following projects to ma
338305
| [![nerfstudio](https://img.shields.io/badge/nerfstudio-NeRF_Framework-green?style=flat-square&logo=github)](https://github.com/nerfstudio-project/nerfstudio) | Collaboration-friendly NeRF toolkit |
339306
| [![MMDetection3D](https://img.shields.io/badge/MMDetection3D-3D_Detection-orange?style=flat-square&logo=github)](https://github.com/open-mmlab/mmdetection3d) | 3D detection framework |
340307
| [![UniAD](https://img.shields.io/badge/UniAD-End--to--End_AD-red?style=flat-square&logo=github)](https://github.com/OpenDriveLab/UniAD) | End-to-end autonomous driving framework |
308+
| [![VADv2](https://img.shields.io/badge/VADv2-End--to--End_AD-crimson?style=flat-square&logo=github)](https://github.com/priest-yang/VADv2) | Vectorized autonomous driving framework |
341309
| [![NAVSIM](https://img.shields.io/badge/NAVSIM-AD_Benchmark-teal?style=flat-square&logo=github)](https://github.com/autonomousvision/navsim) | Non-reactive autonomous vehicle simulation benchmark |
342310
| [![nuPlan](https://img.shields.io/badge/nuPlan-Dataset-purple?style=flat-square&logo=github)](https://www.nuscenes.org/nuplan) | Large-scale autonomous driving dataset |
343311
| [![MetaDrive](https://img.shields.io/badge/MetaDrive-Driving_Simulation-ff69b4?style=flat-square&logo=github)](https://github.com/metadriverse/metadrive) | Compositional driving simulation platform |

docs/data_organization.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ WorldEngine/
2121

2222
## Data Download
2323

24-
We provide pre-processed datasets and model checkpoints via **ModelScope** and **Hugging Face**.
24+
We provide pre-processed datasets and model checkpoints via **[ModelScope](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine)** and **Hugging Face[https://huggingface.co/datasets/OpenDriveLab/WorldEngine]**.
2525

2626
### Option 1: Download from ModelScope (Recommended for Users in China)
2727

@@ -33,11 +33,14 @@ modelscope download --dataset OpenDriveLab/WorldEngine
3333
### Option 2: Download from Hugging Face
3434

3535
```bash
36-
pip install huggingface-hub
37-
hf download OpenDriveLab/WorldEngine
36+
# Install Hugging Face CLI
37+
curl -LsSf https://hf.co/cli/install.sh | bash
38+
39+
# Download the dataset
40+
hf download OpenDriveLab/WorldEngine --repo-type dataset --local-dir /path/to/your/WorldEngine_repo
3841
```
3942

40-
> **Note:** Dataset and model URLs will be announced once the official release is ready. Stay tuned to our [News section](../README.md#-news).
43+
> **Note:** Stay tuned to our [News section](../README.md#-news).
4144
4245
---
4346

0 commit comments

Comments
 (0)