pyzmNg Logo

Getting Started

  • Installation
    • Requirements
    • Path A: Install from PyPI
    • Path B: Install from source
      • What each extra installs
      • Building OpenCV from source
    • macOS (development)
    • Upgrading
    • Optional dependencies
    • Verifying the installation
  • Quick Start
    • Next steps

ZoneMinder API

  • Client & Authentication
    • Connecting to ZoneMinder
      • Constructor parameters
    • Authentication
    • Database access
    • Accessing the full API response
    • Notifications (Push Tokens)
      • Notification fields
      • Helper methods
  • Monitors & Zones
    • Listing monitors
    • Monitor status
    • Monitor control
    • Streaming & snapshot URLs
    • PTZ control
    • Monitor events
    • Getting zones
  • Events & Frames
    • Querying events
    • Per-frame metadata
    • Event methods
    • Bulk operations
  • System & Config
    • System health
    • Configuration
    • Shared memory (real-time monitor status)
    • States, servers, and storage
  • Logging
    • Standalone (ML only, no ZoneMinder)
    • With ZoneMinder
      • How it works
        • Where the log file is written
        • Environment variables
    • Inspecting and testing the log path

Machine Learning

  • Detection
    • Basic usage
      • Detecting objects in an image
      • Working with results
      • Detecting on a ZoneMinder event
      • Audio detection (BirdNET)
      • Loading from YAML config
      • Loading from a YAML config file
    • Architecture overview
    • Configuration
      • DetectorConfig
      • ModelConfig
      • StreamConfig
    • Model discovery
    • The ml_sequence dict format
    • Supported backends
    • Match and frame strategies
      • Frame strategies
      • Match strategies
    • Zone-based filtering
    • Per-type config overrides
    • Pre-existing label gates
    • Past-detection filtering
    • Result objects
      • DetectionResult
      • Detection
      • BBox
  • Remote ML Detection Server
    • Deployment scenarios
      • Scenario 1: ZM + EventServerNg + hooks + pyzm (same box)
      • Scenario 2: ZM + hooks + pyzm (same box, no zmesNg)
      • Scenario 3: ZM box + remote GPU box (split architecture)
    • Available models
      • Model names and discovery
      • --models all (lazy loading)
      • Model directory layout
    • Server setup
      • Installation
      • CLI options
      • YAML config file
    • Client usage
      • Using from_dict()
    • Authentication
    • API reference
      • GET /health
      • GET /models
      • POST /detect
      • POST /detect_urls
      • POST /login
    • objectconfig.yml remote section
  • Model Fine-Tuning
    • Installation
    • Launching the UI
    • Headless / CLI Training
      • Correct Model (headless)
    • Workflow
      • 1. Select Images
      • 2. Review Detections
      • 3. Train & Export
    • Annotation Strategy
      • What to Label (New Class Mode)
      • What to Label (Refine Mode)
      • Background Images
      • Production Deployment
      • How Many Images?
    • Projects
    • Adaptive Fine-Tuning
    • Testing the fine-tuned model
    • Using the fine-tuned model

Testing

  • Testing
    • Running all tests
    • Unit / integration tests
    • ML end-to-end tests
    • ZoneMinder end-to-end tests
    • Test file reference
    • Pytest markers

Examples

  • Example Programs
    • pyzm v2 quick-start
    • Detecting a ZM event stream
    • Detecting a local image
    • Audio detection (BirdNET)
    • Remote detection via pyzm.serve
    • Testing a fine-tuned model

API Reference

  • pyzm - ZoneMinder API, logger, machine learning and tools for python
    • pyzm package
      • ZoneMinder Client
        • ZMClient
      • Logging
        • ZMLogAdapter
        • setup_zm_logging()
      • Machine Learning
        • Detector
        • ModelPipeline
        • filter_by_pattern()
        • filter_by_size()
        • filter_by_zone()
        • filter_past_per_type()
        • load_past_detections()
        • match_past_detections()
        • save_past_detections()
      • Configuration Models
        • DetectorConfig
        • FrameStrategy
        • MatchStrategy
        • ModelConfig
        • ModelFramework
        • ModelType
        • Processor
        • ServerConfig
        • StreamConfig
        • TypeOverrides
        • ZMClientConfig
        • BBox
        • Detection
        • DetectionResult
        • Event
        • Frame
        • Monitor
        • MonitorStatus
        • Notification
        • PTZCapabilities
        • Zone
      • Remote ML Detection Server
        • create_app()
        • create_login_route()
        • create_token_dependency()

Related Projects

  • EventServerNg
  • zmNinjaNg
pyzmNg
  • Search

© Copyright 2019-2026, Pliable Pixels.

Built with Sphinx using a theme provided by Read the Docs.