renaming bunch of stuff

docs/source/apireference.md

@@ -1,4 +1,4 @@
-# API Reference
+# REST API
 
 ```{eval-rst}
 `API Reference <_static/restapi.html>`_

docs/source/examples/index.md

@@ -0,0 +1,18 @@
+# Examples
+Several examples are provided [here](https://github.com/inverted-ai/invertedai/tree/master/examples).
+## Demo
+- **Goolge Colab**: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/inverted-ai/invertedai-drive/blob/develop/examples/Colab-Demo.ipynb)
+
+- **Locally**:  Download the 
+<a href="https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/inverted-ai/invertedai/tree/master/examples" target="_blank">examples directory</a>, navigate to the unzipped directory in terminal and run 
+
+```
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+.venv/bin/jupyter notebook Drive-Demo.ipynb
+```
+
+
+

docs/source/getstarted/drive.md → docs/source/getstarted/gs-drive.md

@@ -1,6 +1,7 @@
-# DRIVE
-**DRIVE** is Inverted AI's cutting-edge realistic driving model trained on millions of miles of traffic data.
-This model can drive all the agents with only the current state of the environment, i.e., one step observations (which could be obtained from **INITIALIZE**) or with multiple past observations.
+# Driving Agents
+
+**{ref}`DRIVE`** is Inverted AI's cutting-edge realistic driving model trained on millions of miles of traffic data.
+This model can drive all the agents with only the current state of the environment, i.e., one step observations (which could be obtained from **{ref}`INITIALIZE`**) or with multiple past observations.
 ```python
 response = iai.drive(
     location="CARLA:Town03:Roundabout",
@@ -16,4 +17,7 @@ response = iai.drive(
 >For convenience and to reduce data overhead, ***drive** also returns _recurrent-states_ which can be feedbacked to the model instead of providing all the past observations.\
 >Furthermore, **drive** drive all the agents for $steps\times \frac{1}{FPS}$ where by default $FPS=10[frames/sec]$, should you require other time resolutions [contact us](mailto:info@inverted.ai).
 
+---
+{ref}`DRIVE`: more information about the python SDK.\
+{ref}`REST API`: more information about the REST API and other programming languages.
 

docs/source/getstarted/gs-initialize.md

@@ -0,0 +1,27 @@
+# Spawning Agents
+To run the simulation, the map must be first populated with agents.
+Inverted AI provides the {ref}`INITIALIZE`, a state-of-the-art model trained with real-life driving scenarios which can generate realistic positions for the initial state of the simulation.
+<!-- Having realistic, complicated and diverse initial conditions are particularly crucial to observer interesting and informative <!-- interaction  -\->between the agents, i.e., the ego vehicle and NPCs (non-player characters). -->
+
+<!-- You can use **INITIALIZE** in two modes: -->
+## Initialize all agents: 
+generates initial conditions (position and speed) for all the agents including the ego vehicle
+```python
+response = iai.initialize(
+    location="CARLA:Town03:Roundabout",
+    agent_count=10,
+)
+```
+<!-- - _Initialize NPCs_: generates initial conditions (position and speed) only for the NPCs according to the provided state of the ego vehicle. -->
+<!-- ```python -->
+<!-- response = iai.initialize( -->
+<!--     location="CARLA:Town03:Roundabout", -->
+<!--     agent_count=10, -->
+<!-- ) -->
+<!-- ``` -->
+> _response_ is a dictionary of _states_, and _agent-attribute_  (_recurrent-states_ is also returned for compatibility with **drive**)\
+> _response["states"]_ is a list of agent states, by default the first on the list is always the ego vehicle.
+
+---
+{ref}`INITIALIZE`: more information about the python SDK.\
+{ref}`REST API`: more information about the REST API and other programming languages.

docs/source/getstarted/installation.md → docs/source/getstarted/gs-installation.md

@@ -10,7 +10,7 @@ For installing the Python package from PyPI [![PyPI][pypi-badge]][pypi-link]:
 pip install invertedai
 ```
 
-The `invertedai` package has minimal dependencies to other python packages. However, it is always recommended to install the package in a virtual environment. 
+The `invertedai` package has minimal dependencies on other python packages. However, it is always recommended to install the package in a virtual environment. 
 
 ```bash
 python3 -m venv .venv

docs/source/getstarted/mapinfo.md → docs/source/getstarted/gs-mapinfo.md

@@ -1,19 +1,24 @@
 # Locations and Maps
 
-Inverted AI provides an assortment of diverse road configurations and geometries, including real-world locations and maps from simulators (CARLA, Huawei SMARTS, ...).\
+Inverted AI provides an assortment of diverse road configurations and geometries, including real-world locations and maps from simulators (CARLA, Huawei SMARTS, ...).
 
 ## AVAILABLE-LOCATIONS
-To search the catalog for available maps to your account (API key) use **iai.available_locations** method by providing keywords
+To search the catalog for available maps to your account (API key) use **{ref}`AVAILABLE-LOCATIONS`** method by providing keywords
 ```python
 iai.available_locations("roundabout", "carla")
 ```
 
-## GET-MAP
-To get information about a scene use **iai.location_info**.
+## LOCATION_INFO
+To get information about a scene use **{ref}`LOCATION_INFO`**.
 ```python
-iai.location_info**("CARLA:Town03:Roundabout")
+iai.location_info("CARLA:Town03:Roundabout")
 ```
 The scene information include the map in [Lanelet2](https://github.com/fzi-forschungszentrum-informatik/Lanelet2) format, map in JPEG format, maximum number of allowed (driveable) vehicles, latitude longitude coordinates (for real-world locations), id and list of traffic light and signs (if any exist in the map), etc.
 
 
+---
+{ref}`LOCATION_INFO`, {ref}`AVAILABLE-LOCATIONS`: more information about the python SDK.\
+{ref}`REST API`: more information about the REST API and other programming languages.
+
+
 

docs/source/getstarted/index.md

@@ -1,5 +1,16 @@
 # Get Started
+```{toctree}
+:maxdepth: 2
+
+
+gs-installation
+gs-drive
+gs-initialize
+gs-mapinfo
+```
 
+
+---
 ## Quick Start
 
 Import `Inverted AI` python package and set the apikey:
@@ -28,30 +39,6 @@ response = iai.drive(
 )
 ```
 
-
-## Demo
-- **Goolge Colab**: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/inverted-ai/invertedai-drive/blob/develop/examples/Colab-Demo.ipynb)
-
-- **Locally**: Download the 
-<a href="https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/inverted-ai/invertedai/tree/master/examples" target="_blank">examples directory</a>, navigate to the unzipped directory in terminal and run 
-
-```
-python3 -m venv .venv
-source .venv/bin/activate
-pip install --upgrade pip
-pip install -r requirements.txt
-.venv/bin/jupyter notebook Drive-Demo.ipynb
-```
-
-
-
-```{toctree}
-:maxdepth: 2
-
-
-installation
-initdrive
-mapinfo
-```
+**Goolge Colab Demo**: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/inverted-ai/invertedai-drive/blob/develop/examples/Colab-Demo.ipynb)
 
 

docs/source/index.md

@@ -35,11 +35,12 @@ Get Started
 
 getstarted/index
 pythonapi/index
+examples/index
 apireference
 ```
 
 ```{toctree}
-:caption: GUIDES
+:caption: INTEGRATIONS
 :maxdepth: 2
 
 

docs/source/pythonapi/index.md

@@ -4,10 +4,10 @@
 ```{toctree}
 :maxdepth: 1
 
-initialize
-drive
-availablemaps
-getmap
+sdk-drive
+sdk-initialize
+sdk-available-locations
+sdk-location-info
 ```
 
 

docs/source/pythonapi/initialize.md → docs/source/pythonapi/sdk-initialize.md

@@ -1,5 +1,6 @@
 # INITIALIZE
 
+
 ```{eval-rst}
 .. autofunction:: invertedai.api_resources.initialize
 ```

docs/source/pythonapi/getmap.md → docs/source/pythonapi/sdk-location-info.md

@@ -1,4 +1,4 @@
-# GET-MAP
+# LOCATION_INFO
 
 
 ```{eval-rst}