Introduce a SimGen example (#791)

* Clean code * clean README * Add a simgen render notebook * Add simgenrender example * Up * Fix * update * Fix * Trying to fix test by using smaller depth image * format
metadriverse · Dec 17, 2024 · 3ba59c2 · 3ba59c2
1 parent 3c6f7d9
commit 3ba59c2
Show file tree

Hide file tree

Showing 6 changed files with 656 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -102,27 +102,7 @@ Traffic vehicles can not response to surrounding vchicles if directly replaying
 Add argument ```--reactive_traffic``` to use an IDM policy control them and make them reactive.
 Press key ```r``` for loading a new scenario, and ```b``` or ```q``` for switching perspective. 
 
-[comment]: <> (### LQY: avoid introducing these trivial things )
 
-[comment]: <> (Run the example of procedural generation of a new map as:)
-
-[comment]: <> (```bash)
-
-[comment]: <> (python -m metadrive.examples.procedural_generation)
-
-[comment]: <> (```)
-
-[comment]: <> (*Note that the scripts above can not be run in a headless machine.*)
-
-[comment]: <> (*Please refer to the installation guideline in documentation for more information about how to launch runing in a headless machine.*)
-
-[comment]: <> (Run the following command to draw the generated maps from procedural generation:)
-
-[comment]: <> (```bash)
-
-[comment]: <> (python -m metadrive.examples.draw_maps)
-
-[comment]: <> (```)
 
 ### Basic Usage
 To build the RL environment in python script, you can simply code in the Farama Gymnasium format as:
@@ -167,66 +147,6 @@ If you use MetaDrive in your own work, please cite:
 }
 ```
 
-## 🎉 Relevant Projects
-
-**Learning to Simulate Self-driven Particles System with Coordinated Policy Optimization**
-\
-Zhenghao Peng, Quanyi Li, Chunxiao Liu, Bolei Zhou 
-\
-*NeurIPS 2021*
-\
-[<a href="https://arxiv.org/pdf/2110.13827.pdf" target="_blank">Paper</a>]
-[<a href="https://github.com/decisionforce/CoPO" target="_blank">Code</a>]
-[<a href="https://decisionforce.github.io/CoPO" target="_blank">Webpage</a>]
-[<a href="https://decisionforce.github.io/CoPO/copo_poster.pdf" target="_blank">Poster</a>]
-[<a href="https://youtu.be/sOw43l8lwxE" target="_blank">Talk</a>]
-[<a href="https://github.com/metadriverse/metadrive-benchmark/tree/main/MARL" target="_blank">Results&Models</a>]
-
-
-**Safe Driving via Expert Guided Policy Optimization**
-\
-Zhenghao Peng*, Quanyi Li*, Chunxiao Liu, Bolei Zhou
-\
-*Conference on Robot Learning (CoRL) 2021*
-\
-[<a href="https://arxiv.org/pdf/2110.06831.pdf" target="_blank">Paper</a>]
-[<a href="https://github.com/decisionforce/EGPO" target="_blank">Code</a>]
-[<a href="https://decisionforce.github.io/EGPO/" target="_blank">Webpage</a>]
-[<a href="https://decisionforce.github.io/EGPO/images/egpo_poster.png" target="_blank">Poster</a>]
-
-**Efficient Learning of Safe Driving Policy via Human-AI Copilot Optimization**
-\
-Quanyi Li*, Zhenghao Peng*, Bolei Zhou
-\
-*ICLR 2022*
-\
-[<a href="https://arxiv.org/pdf/2202.10341.pdf" target="_blank">Paper</a>]
-[<a href="https://github.com/decisionforce/HACO" target="_blank">Code</a>]
-[<a href="https://decisionforce.github.io/HACO/" target="_blank">Webpage</a>]
-[<a href="https://github.com/decisionforce/HACO/blob/main/docs/iclr_poster.pdf" target="_blank">Poster</a>]
-[<a href="https://youtu.be/PiJv4wtp8T8" target="_blank">Talk</a>]
-
-**Human-AI Shared Control via Policy Dissection**
-\
-Quanyi Li, Zhenghao Peng, Haibin Wu, Lan Feng, Bolei Zhou
-\
-*NeurIPS 2022*
-\
-[<a href="https://arxiv.org/pdf/2206.00152.pdf" target="_blank">Paper</a>]
-[<a href="https://github.com/metadriverse/policydissect" target="_blank">Code</a>]
-[<a href="https://metadriverse.github.io/policydissect/" target="_blank">Webpage</a>]
-
-
-And more:
-
-
-* Yang, Yujie, Yuxuan Jiang, Yichen Liu, Jianyu Chen, and Shengbo Eben Li. "Model-Free Safe Reinforcement Learning through Neural Barrier Certificate." IEEE Robotics and Automation Letters (2023).
-
-* Feng, Lan, Quanyi Li, Zhenghao Peng, Shuhan Tan, and Bolei Zhou. "TrafficGen: Learning to Generate Diverse and Realistic Traffic Scenarios." (**ICRA 2023**)
-
-* Zhenghai Xue, Zhenghao Peng, Quanyi Li, Zhihan Liu, Bolei Zhou. "Guarded Policy Optimization with Imperfect Online Demonstrations." (**ICLR 2023**)
-
-
 
 ## Acknowledgement
 

diff --git a/documentation/source/index.rst b/documentation/source/index.rst
@@ -64,6 +64,7 @@ Please feel free to contact us if you have any suggestions or ideas!
    navigation.ipynb
    scenario_description.ipynb
    record_replay.ipynb
+   simgen_render.ipynb
 
 .. toctree::
    :hidden:

diff --git a/documentation/source/install.rst b/documentation/source/install.rst
@@ -18,9 +18,7 @@ We recommend to use the command following to install::
 .. note:: Using ``git clone https://github.com/metadriverse/metadrive.git --single-branch``
   will only pull the main branch and bypass other branches, saving disk space.
 
-It is also allowed to install MetaDrive via pip.However, it is possible that some latest features and bug fixings are not available through PyPI installation::
-
-    pip install metadrive-simulator
+.. note:: We don't recommend installing MetaDrive with ``pip install metadrive-simulator`` because it will download the source code from PyPI, which may not be the latest version.