Skip to content

Commit a6e5c12

Browse files
Update documentation and release notes Live Applications (open-edge-platform#1769)
1 parent c70eb12 commit a6e5c12

File tree

10 files changed

+102
-33
lines changed

10 files changed

+102
-33
lines changed

metro-ai-suite/live-video-analysis/live-metrics-service/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Edit `.env` to configure:
2323

2424
```bash
2525
export REGISTRY="intel/"
26-
export TAG="1.0.0-rc.1"
26+
export TAG="latest"
2727
docker compose up
2828
```
2929

metro-ai-suite/live-video-analysis/live-metrics-service/docs/user-guide/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Edit `.env` to configure:
2929

3030
```bash
3131
export REGISTRY="intel/"
32-
export TAG="1.0.0-rc.0"
32+
export TAG="latest"
3333
docker compose up
3434
```
3535

metro-ai-suite/live-video-analysis/live-metrics-service/docs/user-guide/known-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ curl http://localhost:9090/api/metrics/status
6060

6161
## Limitations
6262

63+
### Limited testing on EMT-S and EMT-D
64+
65+
- This release includes only limited testing on EMT‑S and EMT‑D, some behaviors may not yet be fully validated across all scenarios.
66+
6367
### Single Collector Restriction
6468

6569
- Only one collector can connect at a time
Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Release Notes
22

3+
## 1.0.0.rc1
4+
5+
**Release Date:** Feb 17, 2026
6+
7+
### Features
8+
9+
- Decoupled the application to support live metrices service.
10+
- Fixed bugs and improved codebase.
11+
312
## Version 1.0.0-rc.0
413

514
**Release Date:** January 30, 2026
@@ -16,32 +25,3 @@
1625
- Environment-based configuration
1726
- Automatic client connection cleanup
1827
- Metrics format normalization
19-
20-
### Components
21-
22-
- FastAPI-based service
23-
- Uvicorn ASGI server
24-
- WebSocket support for collector and clients
25-
- Integration with Telegraf collectors
26-
- Docker Compose deployment configuration
27-
28-
### Configuration Options
29-
30-
- `METRICS_PORT`: Service port (default: 9090)
31-
- `LOG_LEVEL`: Logging verbosity (default: INFO)
32-
- `CORS_ORIGINS`: CORS origin allowlist (default: *)
33-
- `TARGET_SERVICE_URL`: Optional service polling URL
34-
- `METRICS_ENDPOINT`: Polling endpoint path
35-
- `POLL_INTERVAL_SECONDS`: Polling frequency
36-
37-
### Known Limitations
38-
39-
- Single collector connection only
40-
- No metrics persistence
41-
- WebSocket-only protocol
42-
- No authentication/authorization
43-
44-
### Docker Images
45-
46-
- `intel/live-metrics-service:1.0.0-rc.0`
47-
- Compatible with `intel/vippet-collector:2025.2.0`

metro-ai-suite/live-video-analysis/live-video-alert/docs/user-guide/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This guide covers the rapid deployment of the Live Video Alert system using Dock
2626
3. **Configure Image Registry and Tag**:
2727
```bash
2828
export REGISTRY="intel/"
29-
export TAG="1.0.0-rc.0"
29+
export TAG="latest"
3030
```
3131
Skip this step if you prefer to build the sample application from source. For detailed instructions, refer to [How to Build from Source](./how-to-build-source.md) guide for details.
3232

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Known Issues
2+
3+
## Limited testing on EMT-S and EMT-D
4+
5+
- This release includes only limited testing on EMT‑S and EMT‑D, some behaviors may not yet be fully validated across all scenarios.
6+
7+
## RTSP stream not connecting
8+
9+
Symptoms:
10+
- Stream shows "No streams active" or fails to add via UI.
11+
- Video feed shows black screen or connection timeout.
12+
13+
Checks:
14+
- Verify RTSP URL is reachable and credentials are correct.
15+
- Ensure firewall allows RTSP port (default 554).
16+
- Test with local file: `file:///path/to/video.mp4`.
17+
18+
## SSE events not updating
19+
20+
Symptoms:
21+
- Dashboard shows stale data or "Last Sync" timestamp doesn't update.
22+
- Alert results don't appear in real-time.
23+
24+
Checks:
25+
- Check browser console (F12) for connection errors.
26+
- Verify OVMS is running: `docker logs ovms-vlm | grep "Started REST"`.
27+
- Test endpoint: `curl -N http://localhost:9000/events`.
28+
- Ensure port 9000 isn't blocked by firewall.
29+
30+
## Port conflicts
31+
32+
If the dashboard or APIs are not reachable, check whether port 9000 is already in use and update the environment variable:
33+
```bash
34+
export PORT=9001
35+
docker compose down && docker compose up -d
36+
```
37+
38+
## VLM validation errors
39+
40+
Symptoms:
41+
- Logs show "Validation failed" or "JSON parse error".
42+
- Alerts show "NO" with reason "Validation error".
43+
44+
Checks:
45+
- Verify model loaded: `docker logs ovms-vlm | grep "AVAILABLE"`.
46+
- Simplify prompts to clear yes/no questions.
47+
- Reduce concurrent alerts (max 4).
48+
49+
## Performance/throughput lower than expected
50+
51+
- Use faster model: `export OVMS_SOURCE_MODEL=OpenVINO/InternVL2-1B-int4-ov`.
52+
- Reduce active streams or increase `ANALYSIS_INTERVAL`.
53+
- Ensure hardware meets minimum requirements (see [system-requirements.md](system-requirements.md)).
54+
55+
## Model download fails
56+
57+
Symptoms:
58+
- OVMS container exits or fails to start.
59+
- Logs show Hugging Face download errors.
60+
61+
Checks:
62+
- Check internet connectivity and proxy settings (`http_proxy`, `https_proxy`).
63+
- Set `HF_TOKEN` environment variable for gated models.
64+
- Ensure 2-4GB disk space available.
65+
- Verify: `docker ps -a | grep ovms-init` shows "Exited (0)".
66+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Release Notes
2+
3+
## 1.0.0-rc.0
4+
### Release Date: 17 Feb 2026
5+
6+
- Initial release of Live Video Alert
7+
- RTSP video ingestion with VLM inference (Phi-3.5-Vision, InternVL2-2B)
8+
- Natural language alert configuration (max 4 alerts per stream)
9+
- Real-time SSE event broadcasting and interactive dashboard

metro-ai-suite/live-video-analysis/live-video-captioning/docs/user-guide/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ By following this guide, you will learn how to:
3535
3. **Configure Image Registry and Tag**:
3636
```bash
3737
export REGISTRY="intel/"
38-
export TAG="1.0.0-rc.1"
38+
export TAG="latest"
3939
```
4040
Skip this step if you prefer to build the sample applciation from source. For detailed instructions, refer to [How to Build from Source](./how-to-build-source.md) guide for details.
4141

metro-ai-suite/live-video-analysis/live-video-captioning/docs/user-guide/known-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,7 @@ If the dashboard or APIs are not reachable, check whether the ports are already
4848
## Gemma model not working in GPU
4949

5050
- Gemma model is not working on GPU. Only working on CPU.
51+
52+
## Limited testing on EMT-S and EMT-D
53+
54+
- 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/live-video-analysis/live-video-captioning/docs/user-guide/release-notes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Release Notes
22

3+
## 1.0.0.rc1
4+
### Relase Date: 17 Feb 2026
5+
6+
- Decoupled the application to support live metrices service.
7+
- Fixed bugs and improved user interface.
8+
39
## 2026.1.3
410
### Relase Date: 16 Jan 2026
511

0 commit comments

Comments
 (0)