Doc-example (#18)

* reactive traffic example

* structure

* structure

* waymo example

* rename and add doc

* finish example

* example

* start from 2
This commit is contained in:
Quanyi Li
2023-08-25 18:35:46 +01:00
committed by GitHub
parent 86e0113921
commit e9d816ddd8
23 changed files with 359 additions and 59 deletions

View File

@@ -10,14 +10,12 @@
ScenarioNet allows users to load scenarios from real-world dataset like Waymo, nuPlan, nuScenes, l5 and synthetic
dataset such as procedural generated ones and safety-critical ones generated by adversarial attack.
The built database provides tools for building training and test sets for ML applications.
![scenarios](docs/asset/scenarios.png)
The built database provides tools for building training and test sets for ML applications.
Powered by [MetaDrive Simulator](https://github.com/metadriverse/metadrive), the scenarios can be reconstructed for
various applications like AD stack test, reinforcement learning, imitation learning, scenario generation and so on.
![sensors](docs/asset/sensor.png)
![system](docs/asset/system_01.png)
## Installation
@@ -78,7 +76,7 @@ python -m scenarionet.scripts.convert_pg -d pg --num_workers=16 --num_scenarios=
For merging two or more database, use
```
python -m scenarionet.merge_database -d /destination/path --from /database1 /2 ...
python -m scenarionet.merge -d /destination/path --from /database1 /2 ...
```
As a database contains a path mapping, one should move database folder with the following script instead of ```cp```
@@ -119,6 +117,6 @@ python -m scenarionet.generate_from_error_file -d /new/database/path --file /err
Visualizing the simulated scenario
```
python -m scenarionet.run_simulation -d /path/to/database --render --scenario_index
python -m scenarionet.sim -d /path/to/database --render --scenario_index
```