# Get Started ## Prerequisites - **System requirements**: Verify that your system meets the [minimum requirements](./get-started/system-requirements.md). - **Docker platform**: Install Docker platform. For installation instructions, see [Get Docker](https://docs.docker.com/get-docker/). - You are familiar with Docker commands and using the terminal. If you are new to Docker platform, see [Docker Documentation](https://docs.docker.com/) for an introduction. ## Quick Start with Setup Script 1. **Clone the Repository :** If you want to clone a specific release branch, replace `main` with the desired tag. To learn more on partial cloning, check the [Repository Cloning guide](https://docs.openedgeplatform.intel.com/2026.3/OEP-articles/contribution-guide.html#repository-cloning-partial-cloning). ```bash git clone --filter=blob:none --sparse --branch release-2026.3.0 https://github.com/open-edge-platform/metro-ai-suite.git cd metro-ai-suite git sparse-checkout set smart-route-planning-agent cd smart-route-planning-agent ``` 2. **Configure _Smart Traffic Intersection Agent_ node endpoints :** In order to plan routes, **Smart Route Planning Agent** needs **_Smart Traffic Intersection Agents_** running on pre-defined nodes. See [this](#multi-node-stack-for-smart-route-planning-agent) to learn more. Edit `src/data/config.json` to add the IP addresses and ports of the edge nodes where Smart Traffic Intersection Agents are running. You can add multiple _Smart Traffic Intersection Agent_ nodes. ### Example configuration for adding three **Smart Traffic Intersection Agent** instances ```json { "api_endpoint": "/api/v1/traffic/current/ws?images=false", "http_api_endpoint": "/api/v1/traffic/current?images=false", "api_hosts": [ { "host": ":" }, { "host": ":" }, { "host": ":" } ] } ``` 3. **Set the required environment variables :** ```bash export REASONING_MODEL_NAME= # e.g. OpenVINO/Qwen3.6-35B-A3B-int4-ov, OpenVINO/Qwen3.5-9B-int8-ov, OpenVINO/Qwen2.5-14B-Instruct-int4-ov export TAG=2026.3.0-rc1 ``` 4. **Run the _Smart Route Planning Agent_ along with all dependencies :** ```bash source setup.sh --run ``` > **Note**: When deployed for the first time, the AI model is downloaded and converted to required format. This can take several minutes depending on your network. This model is later cached in a Docker volume, so that restarts or next deployments with same models are fast. Set `HF_TOKEN` environment variable, as well, if the model repository is gated. ### Stop the application : To stop and remove the containers for the application and its dependencies : ```bash source setup.sh --stop ``` To restart the application along with all the dependencies : ```bash source setup.sh --restart ``` To stop application along with cleaning up all the associated volumes and images: _(**Caution:** This will remove all downloaded AI models for the application. Next run will re-download these models.)_ ```bash source setup.sh --clean ``` ### Validated AI Models The following models were measured on Intel® Xeon® 5th Gen CPU: | Model | Precision | Size | Suitability | | --- | --- | --- | --- | | `OpenVINO/Qwen3.5-9B-int8-ov` | INT8 | 9GB | Dense INT8 model, suitable for basic reasoning on moderate compute environments. | | `OpenVINO/Qwen3.6-35B-A3B-int4-ov` | INT4 | 20GB | MoE Sparse Model, Requires less compute for the performance delivered by models with similar number of parameters. | | `OpenVINO/Qwen2.5-14B-Instruct-int4-ov` | INT4 | 15GB | Dense, considerably large number of parameters. Might require tweaking `OVMS_CACHE_SIZE` and `REASONING_TIMEOUT_SEC`. | > **IMPORTANT**: On slower hardware prefer a smaller model or consider increasing the value of REASONING_TIMEOUT_SEC or OVMS_CACHE_SIZE. See [Environment Variables Guide](./get-started/environment-variables.md) > **Note**: Before adopting a model that is not listed above, please validate it for the map updates in the UI without the fallback notice. If the OVMS container restarts repeatedly, the model is most likely not compatible. ### Fallback behaviour The agent automatically falls back to rule based planning for that update, whenever: - the model server is unreachable, still loading, or times out, - the model could not make a decision - the model hallucinates (For example, names a route that does not exist or has no live traffic data.) ## Manual Setup for Advanced Users For advanced users who need more control over the configuration, you can set up the stack manually using Docker Compose tool. ### Manual Environment Configuration If you prefer to configure environment variables manually instead of using the setup script, see the [Environment Variables Guide](./get-started/environment-variables.md) for details. ### Build from Source and Deploy See [Build from Source](./get-started/build-from-source.md) for instructions on building and running with the Docker Compose tool. ### Helm Deployment See [Deploy with Helm](./get-started/deploy-with-helm.md) for a simple Kubernetes deployment flow. ## Multi-Node Stack for Smart Route Planning Agent The Smart Route Planning Agent works in a multi-node setup with one central _Smart Route Planning Agent_ and multiple _Smart Traffic Intersection Agent_ edge nodes. ### Architecture Overview ![Architecture Overview](./_assets/smart-route-agent-architecture-overview.svg "Architecture Overview") ### Multi-Node Deployment Prerequisites 1. Deploy the [Smart Traffic Intersection Agent](https://docs.openedgeplatform.intel.com/2026.3/edge-ai-suites/smart-traffic-intersection-agent/get-started.html#quick-start-with-setup-script) on each edge node. 2. Ensure network connectivity between the central node and edge nodes. 3. Note the IP address and port of each Smart Traffic Intersection Agent. 4. Update the `api_hosts` field in the `src/data/config.json` file with all the edge node's IP address and port. See [this](#quick-start-with-setup-script) for example configuration. > [!NOTE] > We can add `api_hosts` for even just one instance, however minimum three instances of Smart Traffic Intersection Agent is recommended for proper route planning in the application. ### Deploy the Route Planning Agent After configuring the edge node endpoints, deploy the Smart Route Planning Agent on the central node: ```bash source setup.sh --run ``` The Route Planning Agent will query all configured Smart Traffic Intersection Agents to gather live traffic data for route optimization. :::{toctree} :hidden: get-started/system-requirements get-started/build-from-source get-started/environment-variables get-started/deploy-with-helm :::