Guides Directory - Agent Guide¶

Purpose¶

This directory contains comprehensive feature guides for video analytics, zone configuration, face recognition, and observability capabilities in Home Security Intelligence.

Directory Contents¶

docs/guides/
  AGENTS.md              # This file - directory guide
  video-analytics.md     # AI pipeline overview, detection, scene understanding
  zone-configuration.md  # Zone setup, dwell time, line crossing, household integration
  face-recognition.md    # Face detection, person re-ID, household matching
  profiling.md           # Pyroscope continuous profiling guide

Guide Overview¶

Key Topics by Guide¶

Video Analytics Guide¶

• Object detection with YOLO26
• Scene understanding with Florence-2
• Anomaly detection using CLIP baselines
• Threat detection (weapons, dangerous items)
• Person analysis (pose, demographics, clothing, re-ID)
• Vehicle analysis (classification, plates)
• Risk assessment with Nemotron LLM
• Analytics API reference

Zone Configuration Guide¶

• Zone types (entry_point, exit_point, restricted, monitored)
• Drawing rectangle and polygon zones
• Dwell time tracking
• Line crossing detection
• Approach vector calculation
• Household integration and trust levels
• Schedule-based access rules
• Zone API reference

Face Recognition Guide¶

• Face detection pipeline
• Person re-identification embeddings
• Demographics (age, gender) estimation
• Household member registration
• Cross-camera entity tracking
• Alert integration for unknown persons
• Privacy considerations

Related Documentation¶

Entry Points¶

1. New users: Start with Video Analytics Guide for system overview
2. Zone setup: See Zone Configuration Guide
3. Household setup: See Face Recognition Guide
4. API integration: See Analytics API
5. RTSP/ONVIF cameras: See Cameras API for RTSP configuration and ONVIF device management