Skip to content

Commit 64bd8b1

Browse files
Added descriptions of other examples in the README.
1 parent b11189a commit 64bd8b1

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

examples/README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,10 @@ source .venv/bin/activate
1010
pip install --upgrade pip
1111
pip install --upgrade -r requirements.txt
1212
```
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-
1613
Then, once you obtain an API key, you can run the examples.
1714
```bash
1815
python minimal_example.py --api_key $IAI_API_KEY
1916
```
20-
There are currently three different examples available.
21-
2217
## Minimal Example
2318

2419
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
3934
using Inverted AI API and give you a sandbox to experiment with it. It will save
4035
the generated gif as `iai-example.gif` in the current directory.
4136

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+
4253
## CARLA
4354

4455
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

Comments
 (0)