From 078b2adee093541420c1fdc8d5fa5ae77830b5c3 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Wed, 1 Apr 2026 07:23:38 -0500 Subject: [PATCH] clarify language in docs for configuring detectors via the UI --- docs/docs/configuration/object_detectors.md | 84 ++++++++++----------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/docs/configuration/object_detectors.md b/docs/docs/configuration/object_detectors.md index 5d74ec3929..53aee47475 100644 --- a/docs/docs/configuration/object_detectors.md +++ b/docs/docs/configuration/object_detectors.md @@ -91,7 +91,7 @@ See [common Edge TPU troubleshooting steps](/troubleshooting/edgetpu) if the Edg -Navigate to and select the **EdgeTPU** detector type with device set to `usb`. +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add**, then set device to `usb`. @@ -111,7 +111,7 @@ detectors: -Navigate to and add multiple Edge TPU detectors, specifying `usb:0` and `usb:1` as the device for each. +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add** to add multiple detectors, specifying `usb:0` and `usb:1` as the device for each. @@ -136,7 +136,7 @@ _warning: may have [compatibility issues](https://github.com/blakeblackshear/fri -Navigate to and select the **EdgeTPU** detector type with the device field left empty. +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add**, then leave the device field empty. @@ -156,7 +156,7 @@ detectors: -Navigate to and select the **EdgeTPU** detector type with device set to `pci`. +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add**, then set device to `pci`. @@ -176,7 +176,7 @@ detectors: -Navigate to and add multiple Edge TPU detectors, specifying `pci:0` and `pci:1` as the device for each. +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add** to add multiple detectors, specifying `pci:0` and `pci:1` as the device for each. @@ -199,7 +199,7 @@ detectors: -Navigate to and add multiple Edge TPU detectors with different device types (e.g., `usb` and `pci`). +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add** to add multiple detectors with different device types (e.g., `usb` and `pci`). @@ -246,7 +246,7 @@ After placing the downloaded files for the tflite model and labels in your confi -Navigate to and select the **EdgeTPU** detector type with device set to `usb`. Then navigate to and configure the model settings: +Navigate to and select **EdgeTPU** from the detector type dropdown and click **Add**, then set device to `usb`. Then navigate to and configure the model settings: | Field | Value | | ---------------------------------------- | ----------------------------------------------------------------- | @@ -303,7 +303,7 @@ Use this configuration for YOLO-based models. When no custom model path or URL i -Navigate to and select the **Hailo-8/Hailo-8L** detector type with device set to `PCIe`. Then navigate to and configure the model settings: +Navigate to and select **Hailo-8/Hailo-8L** from the detector type dropdown and click **Add**, then set device to `PCIe`. Then navigate to and configure the model settings: | Field | Value | | ---------------------------------------- | ----------------------- | @@ -359,7 +359,7 @@ For SSD-based models, provide either a model path or URL to your compiled SSD mo -Navigate to and select the **Hailo-8/Hailo-8L** detector type with device set to `PCIe`. Then navigate to and configure the model settings: +Navigate to and select **Hailo-8/Hailo-8L** from the detector type dropdown and click **Add**, then set device to `PCIe`. Then navigate to and configure the model settings: | Field | Value | | --------------------------------------- | ------ | @@ -404,7 +404,7 @@ The Hailo detector supports all YOLO models compiled for Hailo hardware that inc -Navigate to and select the **Hailo-8/Hailo-8L** detector type with device set to `PCIe`. Then navigate to and configure the model settings to match your custom model dimensions and format. +Navigate to and select **Hailo-8/Hailo-8L** from the detector type dropdown and click **Add**, then set device to `PCIe`. Then navigate to and configure the model settings to match your custom model dimensions and format. @@ -459,7 +459,7 @@ When using many cameras one detector may not be enough to keep up. Multiple dete -Navigate to and add multiple **OpenVINO** detectors, each targeting `GPU` or `NPU`. +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add** to add multiple detectors, each targeting `GPU` or `NPU`. @@ -502,7 +502,7 @@ Use the model configuration shown below when using the OpenVINO detector with th -Navigate to and select the **OpenVINO** detector type with device set to `GPU` (or `NPU`). Then navigate to and configure: +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add**, then set device to `GPU` (or `NPU`). Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------ | @@ -552,7 +552,7 @@ After placing the downloaded onnx model in your config folder, use the following -Navigate to and select the **OpenVINO** detector type with device set to `GPU`. Then navigate to and configure: +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add**, then set device to `GPU`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------------- | @@ -614,7 +614,7 @@ After placing the downloaded onnx model in your config folder, use the following -Navigate to and select the **OpenVINO** detector type with device set to `GPU` (or `NPU`). Then navigate to and configure: +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add**, then set device to `GPU` (or `NPU`). Then navigate to and configure: | Field | Value | | ---------------------------------------- | -------------------------------------------------------- | @@ -670,7 +670,7 @@ After placing the downloaded onnx model in your `config/model_cache` folder, use -Navigate to and select the **OpenVINO** detector type with device set to `GPU`. Then navigate to and configure: +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add**, then set device to `GPU`. Then navigate to and configure: | Field | Value | | --------------------------------------- | --------------------------------- | @@ -722,7 +722,7 @@ After placing the downloaded onnx model in your config/model_cache folder, use t -Navigate to and select the **OpenVINO** detector type with device set to `CPU`. Then navigate to and configure: +Navigate to and select **OpenVINO** from the detector type dropdown and click **Add**, then set device to `CPU`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ---------------------------------- | @@ -776,7 +776,7 @@ Using the detector config below will connect to the client: -Navigate to and select the **ZMQ IPC** detector type with the endpoint set to `tcp://host.docker.internal:5555`. +Navigate to and select **ZMQ IPC** from the detector type dropdown and click **Add**, then set the endpoint to `tcp://host.docker.internal:5555`. @@ -810,7 +810,7 @@ When Frigate is started with the following config it will connect to the detecto -Navigate to and select the **ZMQ IPC** detector type with the endpoint set to `tcp://host.docker.internal:5555`. Then navigate to and configure: +Navigate to and select **ZMQ IPC** from the detector type dropdown and click **Add**, then set the endpoint to `tcp://host.docker.internal:5555`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | -------------------------------------------------------- | @@ -971,7 +971,7 @@ When using many cameras one detector may not be enough to keep up. Multiple dete -Navigate to and add multiple **ONNX** detectors. +Navigate to and select **ONNX** from the detector type dropdown and click **Add** to add multiple detectors. @@ -1019,7 +1019,7 @@ After placing the downloaded onnx model in your config folder, use the following -Navigate to and select the **ONNX** detector type. Then navigate to and configure: +Navigate to and select **ONNX** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------------- | @@ -1078,7 +1078,7 @@ After placing the downloaded onnx model in your config folder, use the following -Navigate to and select the **ONNX** detector type. Then navigate to and configure: +Navigate to and select **ONNX** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | -------------------------------------------------------- | @@ -1127,7 +1127,7 @@ After placing the downloaded onnx model in your config folder, use the following -Navigate to and select the **ONNX** detector type. Then navigate to and configure: +Navigate to and select **ONNX** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | -------------------------------------------------------- | @@ -1176,7 +1176,7 @@ After placing the downloaded onnx model in your `config/model_cache` folder, use -Navigate to and select the **ONNX** detector type. Then navigate to and configure: +Navigate to and select **ONNX** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | --------------------------------------- | --------------------------------- | @@ -1221,7 +1221,7 @@ After placing the downloaded onnx model in your `config/model_cache` folder, use -Navigate to and select the **ONNX** detector type. Then navigate to and configure: +Navigate to and select **ONNX** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------- | @@ -1275,7 +1275,7 @@ A TensorFlow Lite model is provided in the container at `/cpu_model.tflite` and -Navigate to and select the **CPU** detector type. Configure the number of threads and add additional CPU detectors as needed (one per camera is recommended). +Navigate to and select **CPU** from the detector type dropdown and click **Add**. Configure the number of threads and click **Add** again to add additional CPU detectors as needed (one per camera is recommended). @@ -1311,7 +1311,7 @@ To integrate CodeProject.AI into Frigate, configure the detector as follows: -Navigate to and select the **DeepStack** detector type. Set the API URL to point to your CodeProject.AI server (e.g., `http://:/v1/vision/detection`). +Navigate to and select **DeepStack** from the detector type dropdown and click **Add**. Set the API URL to point to your CodeProject.AI server (e.g., `http://:/v1/vision/detection`). @@ -1350,7 +1350,7 @@ To configure the MemryX detector, use the following example configuration: -Navigate to and select the **MemryX** detector type with device set to `PCIe:0`. +Navigate to and select **MemryX** from the detector type dropdown and click **Add**, then set device to `PCIe:0`. @@ -1370,7 +1370,7 @@ detectors: -Navigate to and add multiple **MemryX** detectors, specifying `PCIe:0`, `PCIe:1`, `PCIe:2`, etc. as the device for each. +Navigate to and select **MemryX** from the detector type dropdown and click **Add** to add multiple detectors, specifying `PCIe:0`, `PCIe:1`, `PCIe:2`, etc. as the device for each. @@ -1414,7 +1414,7 @@ Below is the recommended configuration for using the **YOLO-NAS** (small) model -Navigate to and select the **MemryX** detector type with device set to `PCIe:0`. Then navigate to and configure: +Navigate to and select **MemryX** from the detector type dropdown and click **Add**, then set device to `PCIe:0`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------------- | @@ -1462,7 +1462,7 @@ Below is the recommended configuration for using the **YOLOv9** (small) model wi -Navigate to and select the **MemryX** detector type with device set to `PCIe:0`. Then navigate to and configure: +Navigate to and select **MemryX** from the detector type dropdown and click **Add**, then set device to `PCIe:0`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------------- | @@ -1509,7 +1509,7 @@ Below is the recommended configuration for using the **YOLOX** (small) model wit -Navigate to and select the **MemryX** detector type with device set to `PCIe:0`. Then navigate to and configure: +Navigate to and select **MemryX** from the detector type dropdown and click **Add**, then set device to `PCIe:0`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ----------------------- | @@ -1556,7 +1556,7 @@ Below is the recommended configuration for using the **SSDLite MobileNet v2** mo -Navigate to and select the **MemryX** detector type with device set to `PCIe:0`. Then navigate to and configure: +Navigate to and select **MemryX** from the detector type dropdown and click **Add**, then set device to `PCIe:0`. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ----------------------- | @@ -1695,7 +1695,7 @@ Use the config below to work with generated TRT models: -Navigate to and select the **TensorRT** detector type with the device set to `0` (the default GPU index). Then navigate to and configure: +Navigate to and select **TensorRT** from the detector type dropdown and click **Add**, then set the device to `0` (the default GPU index). Then navigate to and configure: | Field | Value | | ---------------------------------------- | ------------------------------------------------------------ | @@ -1752,14 +1752,14 @@ Use the model configuration shown below when using the synaptics detector with t -Navigate to and select the **Synaptics** detector type. Then navigate to and configure: +Navigate to and select **Synaptics** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ---------------------------- | | **Custom object detector model path** | `/synaptics/mobilenet.synap` | | **Object detection model input width** | `224` | | **Object detection model input height** | `224` | -| **Tensor format** | `nhwc` | +| **Model Input Tensor Shape** | `nhwc` | | **Label map for custom object detector** | `/labelmap/coco-80.txt` | @@ -1774,7 +1774,7 @@ model: # required path: /synaptics/mobilenet.synap # required width: 224 # required height: 224 # required - tensor_format: nhwc # default value (optional. If you change the model, it is required) + input_tensor: nhwc # default value (optional. If you change the model, it is required) labelmap_path: /labelmap/coco-80.txt # required ``` @@ -1800,7 +1800,7 @@ When using many cameras one detector may not be enough to keep up. Multiple dete -Navigate to and add multiple **RKNN** detectors, each with `num_cores` set to `0` for automatic selection. +Navigate to and select **RKNN** from the detector type dropdown and click **Add** to add multiple detectors, each with `num_cores` set to `0` for automatic selection. @@ -1842,7 +1842,7 @@ This `config.yml` shows all relevant options to configure the detector and expla -Navigate to and select the **RKNN** detector type. Set `num_cores` to `0` for automatic selection (increase for better performance on multicore NPUs, e.g., set to `3` on rk3588). +Navigate to and select **RKNN** from the detector type dropdown and click **Add**. Set `num_cores` to `0` for automatic selection (increase for better performance on multicore NPUs, e.g., set to `3` on rk3588). @@ -2059,7 +2059,7 @@ Once completed, configure the detector as follows: -Navigate to and select the **DeGirum** detector type. Set the location to your AI server (e.g., service name, container name, or `host:port`), the zoo to `degirum/public`, and provide your authentication token if needed. +Navigate to and select **DeGirum** from the detector type dropdown and click **Add**. Set the location to your AI server (e.g., service name, container name, or `host:port`), the zoo to `degirum/public`, and provide your authentication token if needed. @@ -2102,7 +2102,7 @@ It is also possible to eliminate the need for an AI server and run the hardware -Navigate to and select the **DeGirum** detector type. Set the location to `@local`, the zoo to `degirum/public`, and provide your authentication token. +Navigate to and select **DeGirum** from the detector type dropdown and click **Add**. Set the location to `@local`, the zoo to `degirum/public`, and provide your authentication token. @@ -2139,7 +2139,7 @@ If you do not possess whatever hardware you want to run, there's also the option -Navigate to and select the **DeGirum** detector type. Set the location to `@cloud`, the zoo to `degirum/public`, and provide your authentication token. +Navigate to and select **DeGirum** from the detector type dropdown and click **Add**. Set the location to `@cloud`, the zoo to `degirum/public`, and provide your authentication token. @@ -2189,7 +2189,7 @@ Use the model configuration shown below when using the axengine detector with th -Navigate to and select the **AXEngine NPU** detector type. Then navigate to and configure: +Navigate to and select **AXEngine NPU** from the detector type dropdown and click **Add**. Then navigate to and configure: | Field | Value | | ---------------------------------------- | ----------------------- |