You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/README.md
+16-5Lines changed: 16 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,10 @@ source .venv/bin/activate
10
10
pip install --upgrade pip
11
11
pip install --upgrade -r requirements.txt
12
12
```
13
-
*If you run into an issue like`ERROR: No matching distribution found for carla==0.9.13`, your Python version may not
14
-
be CARLA-compatible.
15
-
16
13
Then, once you obtain an API key, you can run the examples.
17
14
```bash
18
15
python minimal_example.py --api_key $IAI_API_KEY
19
16
```
20
-
There are currently three different examples available.
21
-
22
17
## Minimal Example
23
18
24
19
This demonstration script runs without a local simulator and the API is used to control
@@ -39,6 +34,22 @@ meant to provide an illustration of the basic logic for performing co-simulation
39
34
using Inverted AI API and give you a sandbox to experiment with it. It will save
40
35
the generated gif as `iai-example.gif` in the current directory.
41
36
37
+
## Large Map Example
38
+
39
+
This example demonstrates another powerful tool in the Inverted AI API sandbox. The
40
+
`large_initialize` and `large_drive` functions are analogous to `initialize` and `drive`
41
+
but can handle simulatins cover larger areas and larger number of agents than the default
42
+
maximum. A key difference in concepts between the large and standard versions of `initialize`
43
+
is the addition of "regions" which organizes the specific location and number of agents on which
44
+
to make individual `initialize` API calls.
45
+
46
+
## Scenario Log Example
47
+
48
+
This example demonstrates how to use the Inverted AI logging tool. This feature is useful for users
49
+
who wish to capture a simulation or scenario that can be replayed and modified at will. This example
50
+
file shows 3 key features: capturing a log, replaying an original log, and how to use the log to
51
+
initialize a different simulation.
52
+
42
53
## CARLA
43
54
44
55
Please go to the following link to see an example of how the Inverted AI API can integrate with the Carla SDK: [Carla Python SDK Github](https://github.com/carla-simulator/carla/blob/ue5-dev/PythonAPI/examples/invertedai_traffic.py)
0 commit comments