Datasets:

Languages:
English
ArXiv:
License:
OpenDriveLab-org commited on
Commit
6d932eb
·
1 Parent(s): f3402a6

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +25 -19
README.md CHANGED
@@ -35,9 +35,8 @@ tags:
35
  - **Production-scale validation**: Deployed on a mass-produced ADAS platform trained on 80,000+ hours of driving logs, reducing collision rate by up to **45.5%** and achieving zero disengagements in a 200 km on-road test.
36
 
37
  ## News
38
-
39
- - **[2026/04/09]** Official code repository established. Data publication under preparation.
40
  - **[2026/04/09]** Official data release.
 
41
 
42
  ---
43
 
@@ -48,7 +47,6 @@ tags:
48
  - [Dataset Overview](#-dataset-overview)
49
  - [Download](#-download)
50
  - [Directory Structure](#-directory-structure)
51
- - [Benchmark](#-benchmark)
52
  - [Environment Setup](#️-environment-setup)
53
  - [Usage](#-usage)
54
  - [Citation](#-citation)
@@ -76,32 +74,39 @@ WorldEngine/
76
 
77
  ## 🚀 Download
78
 
79
- ### Option 1: ModelScope SDK
80
 
81
- Recommended for quick download:
82
- ```
83
- from modelscope import MsDataset
84
 
85
  # Load the dataset
86
- ds = MsDataset.load('OpenDriveLab/WorldEngine')
87
  ```
88
 
89
- ### Option 2: Git Clone
90
 
91
- For full version control:
92
- ```
93
  # Install Git LFS (Large File Storage)
94
  git lfs install
95
 
96
- git clone https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine.git
 
97
  ```
98
 
99
- ### Option 3: ModelScope CLI
100
- ```
101
- pip install modelscope
102
- modelscope download --dataset OpenDriveLab/WorldEngine
 
 
 
 
103
  ```
104
 
 
 
105
  ---
106
 
107
  ## 📂 Directory Structure
@@ -264,7 +269,7 @@ Follow these steps to set up the dataset:
264
 
265
  | Step | Action | Description |
266
  |:----:|--------|-------------|
267
- | **1** | Download dataset | Use ModelScope SDK or Git Clone |
268
  | **2** | Extract scene assets | Extract split archives in `data/sim_engine/assets/` ([see instructions](#3️⃣-simengine-data-datasim_engine)) |
269
  | **3** | Set environment variables | Configure `WORLDENGINE_ROOT` and related paths |
270
  | **4** | Create symlinks | Link raw datasets (if needed) |
@@ -378,8 +383,9 @@ This dataset is released under the **[CC-BY-NC-SA-4.0](https://creativecommons.o
378
  | Resource | Link |
379
  |:--------:|:-----|
380
  | 🏠 **Project Home** | [WorldEngine GitHub](https://github.com/OpenDriveLab/WorldEngine) |
 
381
  | 📦 **ModelScope** | [Dataset Page](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine) |
382
- | 💬 **Feedback** | [ModelScope Issues](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine/feedback) |
383
  | 📖 **Full Documentation** | [Documentation](https://github.com/OpenDriveLab/WorldEngine/tree/main/docs) |
384
  | 🎨 **Scene Reconstruction** | [MTGS Repository](https://github.com/OpenDriveLab/MTGS) |
385
 
@@ -390,7 +396,7 @@ This dataset is released under the **[CC-BY-NC-SA-4.0](https://creativecommons.o
390
  For questions or suggestions, feel free to reach out:
391
 
392
  - 🐛 **Bug Reports**: [GitHub Issues](https://github.com/OpenDriveLab/WorldEngine/issues)
393
- - 📮 **Dataset Feedback**: [ModelScope Feedback](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine/feedback)
394
 
395
  ---
396
 
 
35
  - **Production-scale validation**: Deployed on a mass-produced ADAS platform trained on 80,000+ hours of driving logs, reducing collision rate by up to **45.5%** and achieving zero disengagements in a 200 km on-road test.
36
 
37
  ## News
 
 
38
  - **[2026/04/09]** Official data release.
39
+ - **[2026/04/10]** Official code repository established. Data publication under preparation.
40
 
41
  ---
42
 
 
47
  - [Dataset Overview](#-dataset-overview)
48
  - [Download](#-download)
49
  - [Directory Structure](#-directory-structure)
 
50
  - [Environment Setup](#️-environment-setup)
51
  - [Usage](#-usage)
52
  - [Citation](#-citation)
 
74
 
75
  ## 🚀 Download
76
 
77
+ ### Option 1: Hugging Face Hub (Recommended)
78
 
79
+ Use the `datasets` library for quick download:
80
+ ```python
81
+ from datasets import load_dataset
82
 
83
  # Load the dataset
84
+ ds = load_dataset('OpenDriveLab/WorldEngine')
85
  ```
86
 
87
+ ### Option 2: Git Clone with LFS
88
 
89
+ For full version control and manual access:
90
+ ```bash
91
  # Install Git LFS (Large File Storage)
92
  git lfs install
93
 
94
+ # Clone the dataset repository
95
+ git clone https://huggingface.co/datasets/OpenDriveLab/WorldEngine
96
  ```
97
 
98
+ ### Option 3: Hugging Face CLI
99
+
100
+ ```bash
101
+ # Install Hugging Face CLI
102
+ curl -LsSf https://hf.co/cli/install.sh | bash
103
+
104
+ # Download the dataset
105
+ hf download OpenDriveLab/WorldEngine --repo-type dataset --local-dir /path/to/your/WorldEngine_repo
106
  ```
107
 
108
+ 💡 **Note**: Large files are stored using Git LFS. Make sure Git LFS is properly installed before cloning.
109
+
110
  ---
111
 
112
  ## 📂 Directory Structure
 
269
 
270
  | Step | Action | Description |
271
  |:----:|--------|-------------|
272
+ | **1** | Download dataset | Use Hugging Face Hub or Git Clone |
273
  | **2** | Extract scene assets | Extract split archives in `data/sim_engine/assets/` ([see instructions](#3️⃣-simengine-data-datasim_engine)) |
274
  | **3** | Set environment variables | Configure `WORLDENGINE_ROOT` and related paths |
275
  | **4** | Create symlinks | Link raw datasets (if needed) |
 
383
  | Resource | Link |
384
  |:--------:|:-----|
385
  | 🏠 **Project Home** | [WorldEngine GitHub](https://github.com/OpenDriveLab/WorldEngine) |
386
+ | 🤗 **Hugging Face** | [Dataset Page](https://huggingface.co/datasets/OpenDriveLab/WorldEngine) |
387
  | 📦 **ModelScope** | [Dataset Page](https://www.modelscope.cn/datasets/OpenDriveLab/WorldEngine) |
388
+ | 💬 **Discussions** | [Hugging Face Discussions](https://huggingface.co/datasets/OpenDriveLab/WorldEngine/discussions) |
389
  | 📖 **Full Documentation** | [Documentation](https://github.com/OpenDriveLab/WorldEngine/tree/main/docs) |
390
  | 🎨 **Scene Reconstruction** | [MTGS Repository](https://github.com/OpenDriveLab/MTGS) |
391
 
 
396
  For questions or suggestions, feel free to reach out:
397
 
398
  - 🐛 **Bug Reports**: [GitHub Issues](https://github.com/OpenDriveLab/WorldEngine/issues)
399
+ - 💬 **Discussions**: [Hugging Face Discussions](https://huggingface.co/datasets/OpenDriveLab/WorldEngine/discussions)
400
 
401
  ---
402