[ViPPET] Release ViPPET 2025.2 – merge feature branch into main

.github/workflows/vippet-pr-workflow.yaml

@@ -6,6 +6,7 @@ on:
     branches:
       - main
       - release-*
+      - initial-vippet-api
     paths:
       - 'tools/visual-pipeline-and-platform-evaluation-tool/**'
   workflow_dispatch:
@@ -24,7 +25,7 @@ jobs:
       fail-fast: false
     uses: open-edge-platform/orch-ci/.github/workflows/pre-merge.yml@070a95caeeed643fc9d1a34c11eac78179ce136d  # 0.1.34
     with:
-      runs_on: ubuntu-24.04
+      runs_on: ubuntu-24.04-16core-64GB
       bootstrap_tools: 'nodejs'
       run_version_check: false
       run_build: false

.gitignore

@@ -0,0 +1,5 @@
+.gradio/*
+.idea/*
+tools/visual-pipeline-and-platform-evaluation-tool/.venv/*
+tools/visual-pipeline-and-platform-evaluation-tool/intel/*
+tools/visual-pipeline-and-platform-evaluation-tool/models/*

tools/visual-pipeline-and-platform-evaluation-tool/.gitignore

@@ -1,5 +1,8 @@
 __pycache__
 .coverage
 .env
+.idea
+shared/collector-signals/
 shared/models/output/*
-shared/videos/
+shared/videos/input/*
+shared/videos/video-generator/*

tools/visual-pipeline-and-platform-evaluation-tool/Makefile

@@ -25,7 +25,8 @@ $(VENV_DIR): $(PROJECT_NAME)/requirements.txt ## Create Python venv
 	python3 -m venv $@ ;\
 	set +u; . ./$@/bin/activate; set -u ;\
 	python -m pip install --upgrade pip ;\
-	python -m pip install -r $(PROJECT_NAME)/requirements-dev.txt
+	python -m pip install -r $(PROJECT_NAME)/requirements-dev.txt ;\
+	python -m pip install -r video_generator/requirements.txt # needed for pyright checks
 
 all: lint build run test ## Run lint, build, run and test
 
@@ -56,76 +57,79 @@ pyright: $(VENV_DIR) ## Run pyright type checker
 	pyright --version ;\
 	pyright .
 
-# Environment setup target: always run before build/run targets that need .env
-env-setup:
+generate_openapi: $(VENV_DIR) ## Generate OpenAPI schema file
+	set +u; . ./$</bin/activate; set -u ;\
+	cd $(PROJECT_NAME) ;\
+	PYTHONPATH=. SUPPORTED_MODELS_FILE=../shared/models/supported_models.yaml RECORDINGS_PATH=../shared/videos/input python ../generate_openapi.py
+
+env-setup: ## Environment setup target: always run before build/run targets that need .env and shared dirs
+	mkdir -p shared/collector-signals && chmod o+w shared/collector-signals
+	mkdir -p shared/models/output && chmod o+w shared/models/output
+	mkdir -p shared/videos/input && chmod o+w shared/videos/input
+	mkdir -p shared/videos/video-generator && chmod o+w shared/videos/video-generator
 	./setup_env.sh
 
-build: env-setup ## Build core images (vippet-app, vippet-collector)
-	docker compose build
+build: env-setup ## Build core images (vippet-app, vippet-collector, vippet-ui)
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build
 
-build-dev: env-setup ## Build core dev images (vippet-app, vippet-collector)
-	docker compose -f $(COMPOSE_FILE) -f $(DEV_COMPOSE_FILE) build
+build-dev: env-setup ## Build core dev images (vippet-app, vippet-collector, vippet-ui)
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml -f $(DEV_COMPOSE_FILE) build
 
 build-videogenerator: env-setup ## Build videogenerator image
-	docker compose build videogenerator
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build videogenerator
 
 build-models: env-setup ## Build model image
-	docker compose build models
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build models
 
 docker-build: build build-videogenerator build-models ## Build all images
 
 run: env-setup install-models-once ## Run the docker compose services
-	docker compose up -d
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml up -d
 
 run-videogenerator: env-setup build-videogenerator ## Run only the videogenerator service
-	mkdir -p shared/videos && chmod o+w shared/videos
-	docker compose up -d videogenerator
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml up -d videogenerator
 
 run-dev: env-setup install-models-once ## Run the docker compose services for development
-	docker compose -f $(COMPOSE_FILE) -f $(DEV_COMPOSE_FILE) up -d
+	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml -f $(DEV_COMPOSE_FILE) up -d
 
 test: env-setup ## Run tests and generate coverage report
-    # Run tests using the vippet-cpu container (tests are device agnostic)
+    # Run tests using the cpu profile (tests are device agnostic)
     # Override DOCKER_TAG with '-test' suffix only for this docker compose run
-	TARGET=test DOCKER_TAG="test" docker compose -f $(COMPOSE_FILE) run \
-	--build --rm --no-deps --volume $(PROJECT_DIR):/home/dlstreamer/vippet vippet-cpu bash -c "\
+	. .env && TARGET=test DOCKER_TAG="test" docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run \
+	--build --rm --no-deps --volume $(PROJECT_DIR):/home/dlstreamer/vippet vippet bash -c "\
 		cd $(PROJECT_NAME) && \
 		python -m coverage run --source=./ --data-file=/tmp/.vippet-coverage -m unittest discover -v -s ./tests -p '*_test.py' && \
 		python -m coverage report --data-file=/tmp/.vippet-coverage --omit=*/config-3.py,*/config.py,*_test.py"
 
 install-models-once: env-setup ## Handle models download and installation (once)
-	mkdir -p shared/models/output && chmod o+w shared/models/output
-	MODEL_INSTALLATION=once docker compose run --rm -it models
+	. .env && MODEL_INSTALLATION=once docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models
 
 install-models-force: env-setup ## Handle models download and installation (force)
-	mkdir -p shared/models/output && chmod o+w shared/models/output
-	MODEL_INSTALLATION=force docker compose run --rm -it models
+	. .env && MODEL_INSTALLATION=force docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models
 
 install-models-all: env-setup ## Install all models automatically (no dialog)
-	mkdir -p shared/models/output && chmod o+w shared/models/output
-	MODEL_INSTALLATION=all docker compose run --rm -it models
+	. .env && MODEL_INSTALLATION=all docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models
 
 shell: env-setup ## Open shell in specified container (i.e. make shell SERVICE=vippet)
 	docker exec -it $(SERVICE) bash
 
-shell-vippet: env-setup ## Open shell in vippet container
+shell-vippet: ## Open shell in vippet container
 	$(MAKE) shell SERVICE=vippet
 
-shell-models: env-setup ## Open shell in models container
+shell-models: ## Open shell in models container
 	$(MAKE) shell SERVICE=models
 
-shell-collector: env-setup ## Open shell in collector container
+shell-collector: ## Open shell in collector container
 	$(MAKE) shell SERVICE=collector
 
-shell-videogenerator: env-setup ## Open shell in videogenerator container
+shell-videogenerator: ## Open shell in videogenerator container
 	$(MAKE) shell SERVICE=videogenerator
 
 stop: ## Stop the docker compose services
-	@VIPPET_SERVICE=$$(docker compose ps --services | grep "^vippet-" | head -n 1 || echo ""); \
-	docker compose down models collector videogenerator $$VIPPET_SERVICE
+	docker compose down models collector videogenerator vippet-ui vippet
 
 clean: ## Clean all build artifacts
-	rm -rf shared/models/output/ shared/videos/
+	rm -rf shared/collector-signals shared/models/output/ shared/videos/input shared/videos/video-generator
 
 help: ## Print help for each target
 	@echo ViPPET make targets

tools/visual-pipeline-and-platform-evaluation-tool/collector/Dockerfile

@@ -1,29 +1,61 @@
+# Copyright (C) 2025 Intel Corporation
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions
+# and limitations under the License.
+
+# SPDX-License-Identifier: Apache-2.0
+
+# Base image for building qmassa
 FROM docker.io/library/rust:1.88 AS qmassa
 
+# Set environment variable to non-interactive mode (avoids some prompts)
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install necessary dependencies
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        libudev-dev && \
+    apt-get install --yes --no-install-recommends libudev-dev && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
-RUN cargo install --locked --git https://github.com/ulissesf/qmassa.git --tag v1.0.1
+# Install qmassa
+RUN cargo install --locked [email protected]
 
+# Final image for the collector
 FROM docker.io/library/telegraf:1.36.3 AS collector
 
+# Copy qmassa binary from the build stage
 COPY --from=qmassa /usr/local/cargo/bin/qmassa /usr/local/bin/qmassa
 
+# Set environment variable to non-interactive mode (avoids some prompts)
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install necessary dependencies
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        python3 && \
+    apt-get install --yes --no-install-recommends python3 supervisor && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
+# Set working directory
 WORKDIR /app
 
+# Copy configuration and scripts
+COPY supervisord.conf /etc/supervisor/conf.d/supervisord.conf
 COPY telegraf.conf /etc/telegraf
 COPY qmassa_reader.py qmassa_reader.py
 COPY read_cpu_freq.sh read_cpu_freq.sh
-RUN chmod +x read_cpu_freq.sh
+COPY entrypoint.sh /entrypoint.sh
+
+# Make scripts executable
+RUN chmod +x read_cpu_freq.sh /entrypoint.sh
 
-# nosemgrep: missing-user-entrypoint
-ENTRYPOINT ["/usr/bin/telegraf", "--config", "/etc/telegraf/telegraf.conf"]
+# Set the entrypoint to the custom script
+CMD ["/entrypoint.sh"]

tools/visual-pipeline-and-platform-evaluation-tool/collector/entrypoint.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Ensure the fps.txt file exists and is initialized to 0.0 and can be written to by vippet
+echo "0.0" > /app/.collector-signals/fps.txt
+chmod o+w /app/.collector-signals/fps.txt
+
+# Ensure the named pipe for qmassa exists and is writable
+if [ ! -p /app/qmassa.fifo ]; then
+    mkfifo /app/qmassa.fifo
+fi
+chmod 666 /app/qmassa.fifo
+
+# Telegraf and qmassa are started and managed by supervisord
+/usr/bin/supervisord -c /etc/supervisor/conf.d/supervisord.conf