Minor documentation updates for Smart Traffic and Smart Route applications (open-edge-platform#1767)

Co-authored-by: Madhuri Kumari <madhuri.rai07@gmail.com>

Author: bharagha

metro-ai-suite/smart-route-planning-agent/docs/user-guide/get-started.md

@@ -32,14 +32,20 @@ source setup.sh --setup
 For a more granular control, run these commands:
 
 ```bash
-# Start services only (after setup)
+# Build service images only (without starting containers)
+source setup.sh --build
+
+# Start services only (after build)
 source setup.sh --run
 
 # Stop services
 source setup.sh --stop
 
 # Restart services
 source setup.sh --restart
+
+# Clean up containers, volumes, images, networks, and all related resources
+source setup.sh --clean
 ```
 
 

metro-ai-suite/smart-route-planning-agent/docs/user-guide/release-notes.md

@@ -1,8 +1,8 @@
 # Release Notes
 
-## Current Release: 1.0.0
+## Current Release: 1.0.0-rc1
 
-**Release Date**: 2025-08-19
+**Release Date**: 17 Feb 2026
 
 ### Features
 
@@ -21,9 +21,6 @@
 - **Enhanced Error Handling**: Comprehensive error management across MQTT, VLM, and image services
   - **Impact**: Improved service reliability and diagnostic capabilities
 
-### Technical Specifications
-
-- **Supported Languages**: Python programming version 3.10 or higher
-- **Architecture**: Microservice with Docker containerization
-- **Dependencies**: FastAPI, MQTT client, aiohttp, and structlog
-- **External Integrations**: MQTT brokers, VLM OpenVINO serving, and camera image streams
+### Known Issues
+- Helm is not supported
+- This release includes only limited testing on EMT‑S and EMT‑D, some behaviors may not yet be fully validated across all scenarios.

metro-ai-suite/smart-route-planning-agent/setup.sh

@@ -26,6 +26,7 @@ show_help() {
     echo -e "  ${GREEN}--run${NC}         Start the Smart-Route-Planning-Agent container"
     echo -e "  ${GREEN}--stop${NC}        Stop the running container"
     echo -e "  ${GREEN}--restart${NC}     Restart the Smart-Route-Planning-Agent container"
+    echo -e "  ${GREEN}--clean${NC}       Remove containers, volumes, images, and all related resources"
     echo -e "  ${GREEN}--help${NC}        Show this help message"
     echo ""
     echo -e "${BLUE}Quick Start:${NC}"
@@ -169,6 +170,31 @@ case "$1" in
             if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then exit 1; else return 1; fi
         fi
         ;;
+    "--clean")
+        echo -e "${YELLOW}Cleaning up Smart-Route-Planning-Agent resources...${NC}"
+
+        # Stop and remove containers
+        echo -e "${YELLOW}Stopping and removing containers...${NC}"
+        docker compose -f "$COMPOSE_MAIN" -p "$PROJECT_NAME" down 2>/dev/null || true
+        echo -e "${GREEN}Containers stopped and removed.${NC}"
+
+        # Remove project volumes
+        #echo -e "${YELLOW}Removing volumes...${NC}"
+        #docker volume ls --format '{{.Name}}' | grep "$PROJECT_NAME" | xargs -r docker volume rm 2>/dev/null || true
+        #echo -e "${GREEN}Volumes removed.${NC}"
+
+        # Remove project-related images
+        echo -e "${YELLOW}Removing container images...${NC}"
+        docker images --format '{{.Repository}}:{{.Tag}} {{.ID}}' | grep "smart-route-planning-agent" | awk '{print $2}' | xargs -r docker rmi -f 2>/dev/null || true
+        echo -e "${GREEN}Images removed.${NC}"
+
+        # Remove project networks
+        #echo -e "${YELLOW}Removing networks...${NC}"
+        #docker network ls --format '{{.Name}}' | grep "$PROJECT_NAME" | xargs -r docker network rm 2>/dev/null || true
+        #echo -e "${GREEN}Networks removed.${NC}"
+
+        echo -e "${GREEN}Clean up completed successfully. All containers, volumes, images, networks, and related resources have been removed.${NC}"
+        ;;
     *)
         echo -e "${RED}Unknown command: $1${NC}"
         echo -e "${YELLOW}Use '--help' for usage information${NC}"

metro-ai-suite/smart-traffic-intersection-agent/docs/user-guide/get-started.md

@@ -19,6 +19,13 @@ traffic data streaming, or use the included broker.
 - **Docker commands and terminal usage**: You are familiar with Docker commands and using the
 terminal. If you are new to Docker, see [Docker Documentation](https://docs.docker.com/) for
 an introduction.
+- **Hugging Face token**: Set your token using `export HUGGINGFACE_TOKEN="<your-huggingface-token>"`
+- **Registry configuration**: To pull pre-built images from a specific registry, set the `REGISTRY` and `TAG` parameters. Following is the recommended default setting.
+  ```bash
+  export REGISTRY="intel"
+  export TAG="latest"
+  ```
+
 
 ## Quick Start with Setup Script
 
@@ -52,7 +59,31 @@ This single command will:
 - Build Docker images
 - Start services in the Smart Traffic Intersection Agent's application stack
 
-### 3. Access Services
+### 3. Run alternative setup options
+
+For a more granular control, run these commands:
+
+```bash
+#  Set environment variables without building image or starting any containers
+source setup.sh --setenv
+
+# Build service images only (without starting containers)
+source setup.sh --build
+
+# Start services without building the image
+source setup.sh --run
+
+# Stop services
+source setup.sh --stop
+
+# Restart services. The variable `service_type` can be set to `agent`, `deps`, and `all`. Run with --help to get details of each type.
+source setup.sh --restart [service_type]
+
+# Clean up containers. Run with --help to get details of the option.
+source setup.sh --clean [option]
+```
+
+### 4. Access Services
 
 When the script completes, it will show the URLs to access the services. Go to these URLs so
 that the respective services can access them in a web browser.
@@ -162,14 +193,15 @@ To spin-up more instances - say `n number of new instances`, repeat the steps me
 
 ## Advanced Environment Configuration
 
-For advanced users who need more control over the configuration, you can configure the
-following environment variables before running the setup script to override the default
-behaviour:
+For advanced users who need more control over the configuration, you can configure the following environment variables before running the setup script to override the default behaviour:
 
 ```bash
 # Set log level to debug to help in debugging issues, default value is info
 export LOG_LEVEL=DEBUG
 
+# Select iGPU as the accelerator to perform VLM inference. By default, it is set to CPU 
+export VLM_DEVICE=GPU
+
 # Change the VLM Model name. Default value set in script.sh is microsoft/Phi-3.5-vision-instruct.
 export VLM_MODEL_NAME=Qwen/Qwen2.5-VL-3B-Instruct
 
@@ -183,7 +215,12 @@ export VLM_TOP_P=0.3                    # Default 0.1, range 0-1; another parame
 export HIGH_DENSITY_THRESHOLD=5        # Default value 10
 export MODERATE_DENSITY_THRESHOLD=3    # Default value 5; Make sure this is less than HIGH_DENSITY_THRESHOLD
 export TRAFFIC_BUFFER_DURATION=20      # Default value 30; Analysis window of traffic feeds in seconds
+
+# To mock the weather data (say in airgapped deployment)
+export WEATHER_MOCK=True
 ```
+### Customizing the video used by sample application
+The video used by this sample application is determined by the configuration in [Smart Intersection application](../../../metro-vision-ai-app-recipe/smart-intersection/). Refer to its documentation for further details.
 
 ## Accessing the Services
 

metro-ai-suite/smart-traffic-intersection-agent/docs/user-guide/get-started/build-from-source.md

@@ -13,16 +13,16 @@ This section shows how to build the Smart Traffic Intersection Agent from source
 ### 1. Clone the Repository
 
 ```bash
-git clone https://github.com/open-edge-platform/edge-ai-libraries.git
-cd edge-ai-libraries/microservices/scene-intelligence
+git clone https://github.com/open-edge-platform/edge-ai-suites.git
+cd metro-ai-suite/smart-traffic-intersection-agent/
 ```
 
 ### 2. Build the Docker Image
 
 Build the Traffic Intersection Agent:
 
 ```bash
-docker compose -f docker/compose.yaml build traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml build traffic-intersection-agent
 ```
 
 ### 3. Run the Service
@@ -32,7 +32,7 @@ docker compose -f docker/compose.yaml build traffic-intersection-agent
 source setup.sh --run
 
 # Or manually with Docker Compose
-docker compose -f docker/compose.yaml up traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml up traffic-intersection-agent
 ```
 
 ### 4. Verify the Build
@@ -45,7 +45,7 @@ curl http://localhost:8081/health
 curl http://localhost:7860/
 
 # View logs
-docker compose -f docker/compose.yaml logs traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml logs traffic-intersection-agent
 ```
 
 ### Verify API Endpoints
@@ -64,13 +64,13 @@ After you have edited the code, rebuild:
 
 ```bash
 # Rebuild the image
-docker compose -f docker/compose.yaml build traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml build traffic-intersection-agent
 
 # Restart the service
-docker compose -f docker/compose.yaml up -d traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml up -d traffic-intersection-agent
 
 # View startup logs
-docker compose -f docker/compose.yaml logs traffic-intersection-agent
+docker compose -f docker/agent-compose.yaml logs traffic-intersection-agent
 ```
 
 ## Learn More

metro-ai-suite/smart-traffic-intersection-agent/docs/user-guide/release-notes.md

@@ -1,8 +1,24 @@
 # Release Notes
 
-## Current Release
+## Current Release: 1.0.0-rc1
 
-**Version**: 1.0.0\
-**Release Date**: TBD
+**Release Date**: 17 Feb 2026
 
-- Added Smart Traffic Intersection Agent
+### Features
+
+- **Real-time Traffic Analysis**: Comprehensive directional traffic density monitoring with MQTT integration
+- **VLM Integration**: Vision Language Model (VLM)-powered traffic scene analysis with sustained traffic detection
+- **Sliding Window Analysis**: 15-second sliding window with 3-second sustained threshold for accurate traffic state detection
+- **Camera Image Management**: Intelligent camera image retention and coordination between API and VLM services
+- **RESTful API**: Complete HTTP API for traffic summaries, intersection monitoring, and VLM analysis retrieval
+
+### Improvements
+
+- **Concurrency Control**: Semaphore-based VLM worker management for optimal resource utilization
+- **Image Retention Logic**: Camera images persist with VLM analysis for consistent data correlation
+- **Enhanced Error Handling**: Comprehensive error management across MQTT, VLM, and image services
+- **Setup Script Enhancements**: Added `--build` option for building service images without starting containers
+
+### Known Issues
+- Helm is not supported
+- This release includes only limited testing on EMT‑S and EMT‑D, some behaviors may not yet be fully validated across all scenarios.

metro-ai-suite/smart-traffic-intersection-agent/setup.sh

@@ -45,6 +45,7 @@ if [ "$#" -eq 0 ] || ([ "$#" -eq 1 ] && [ "$1" = "--help" ]); then
     echo -e "${YELLOW}USAGE: ${GREEN}source setup.sh ${BLUE}[--setenv | --setup | --run | --restart [agent|deps|all] | --stop | --clean | --help]"
     echo -e "${YELLOW}"
     echo -e "  --setenv:                 Set environment variables without building image or starting any containers"
+    echo -e "  --build:                  Build the service images without starting containers"
     echo -e "  --setup:                  Build and run the services"
     echo -e "  --run:                    Start the services without building image (if already built)"
     echo -e "  --restart [service_type]: Restart services"
@@ -63,7 +64,7 @@ elif [ "$#" -gt 2 ]; then
     echo -e "${YELLOW}Use --help for usage information${NC}"
     return 1
 
-elif [ "$1" != "--help" ] && [ "$1" != "--setenv" ] && [ "$1" != "--run" ] && [ "$1" != "--setup" ] && [ "$1" != "--restart" ] && [ "$1" != "--stop" ] && [ "$1" != "--clean" ]; then
+elif [ "$1" != "--help" ] && [ "$1" != "--setenv" ] && [ "$1" != "--run" ] && [ "$1" != "--build" ] && [ "$1" != "--setup" ] && [ "$1" != "--restart" ] && [ "$1" != "--stop" ] && [ "$1" != "--clean" ]; then
     # Default case for unrecognized option
     echo -e "${RED}Unknown option: $1 ${NC}"
     echo -e "${YELLOW}Use --help for usage information${NC}"
@@ -167,7 +168,7 @@ check_and_setup_dependencies() {
 }
 
 # Verify dependencies and setup (skip if stopping/cleaning services or only showing help or setting env vars)
-if [ "$1" != "--help" ] && [ "$1" != "--setenv" ] && [ "$1" != "--clean" ] && [ "$1" != "--stop" ]; then
+if [ "$1" != "--help" ] && [ "$1" != "--setenv" ] && [ "$1" != "--build" ] && [ "$1" != "--clean" ] && [ "$1" != "--stop" ]; then
     check_and_setup_dependencies
 
     if [ $? -ne 0 ]; then
@@ -275,6 +276,25 @@ print_all_service_host_endpoints() {
     echo -e
 }   
 
+# Build service images without starting containers
+build_service() {
+    echo -e "${BLUE}==> Building Smart-Traffic-Intersection-Agent ${RED}${PROJECT_NAME} ${BLUE}...${NC}"
+
+    # Build the service images
+    if [ -L "${APP_DIR}/docker/ri-compose.yaml" ]; then
+        docker compose --project-directory $DEPS_DIR -f "${APP_DIR}/docker/ri-compose.yaml" -f "${APP_DIR}/docker/agent-compose.yaml" -p $PROJECT_NAME build
+    else
+        docker compose -f "${APP_DIR}/docker/agent-compose.yaml" -p $PROJECT_NAME build
+    fi
+
+    if [ $? -eq 0 ]; then
+        echo -e "${GREEN}Smart-Traffic-Intersection-Agent images built successfully!${NC}"
+    else
+        echo -e "${RED}Failed to build Smart-Traffic-Intersection-Agent images${NC}"
+        return 1
+    fi
+}
+
 # Build agent Backend/UI image and run its container along with all other services - to run Traffic Intersection Agent End-to-End
 build_and_start_service() {
     echo -e "${BLUE}==> Starting Smart-Traffic-Intersection-Agent ${RED}${PROJECT_NAME} ${BLUE}...${NC}"
@@ -403,6 +423,9 @@ fi
 
 # Execute actions based on options provided to setup script
 case $1 in
+    --build)
+        build_service
+        ;;
     --setup)
         build_and_start_service
         ;;