From b83e214df50105b2c5ba992c15a0ab012394b5e0 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Tue, 1 Apr 2025 07:59:04 -0500 Subject: [PATCH] Docs updates (#17478) * face rec, lpr, and plus docs updates * clarify plus --- docs/docs/configuration/face_recognition.md | 2 ++ docs/docs/configuration/license_plate_recognition.md | 5 +++-- docs/docs/configuration/reference.md | 2 +- docs/docs/integrations/plus.md | 2 ++ 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/docs/configuration/face_recognition.md b/docs/docs/configuration/face_recognition.md index fe6ed1f99..8dc4ac7b2 100644 --- a/docs/docs/configuration/face_recognition.md +++ b/docs/docs/configuration/face_recognition.md @@ -57,6 +57,8 @@ Fine-tune face recognition with these optional parameters: - Default: `0.8`. - `recognition_threshold`: Recognition confidence score required to add the face to the object as a sub label. - Default: `0.9`. +- `save_attempts`: Number of images of recognized faces to save for training. + - Default: `100`. - `blur_confidence_filter`: Enables a filter that calculates how blurry the face is and adjusts the confidence based on this. - Default: `True`. diff --git a/docs/docs/configuration/license_plate_recognition.md b/docs/docs/configuration/license_plate_recognition.md index ccb9a16a6..a9c487b0e 100644 --- a/docs/docs/configuration/license_plate_recognition.md +++ b/docs/docs/configuration/license_plate_recognition.md @@ -174,8 +174,8 @@ cameras: type: "lpr" # required to use dedicated LPR camera mode detect: enabled: True - fps: 5 # increase if vehicles move quickly - min_initialized: 2 # set at fps divided by 3 for very fast cars + fps: 5 # increase to 10 if vehicles move quickly across your frame + min_initialized: 2 width: 1920 height: 1080 objects: @@ -206,6 +206,7 @@ With this setup: - Snapshots will have license plate bounding boxes on them. - The `frigate/events` MQTT topic will publish tracked object updates. - Debug view will display `license_plate` bounding boxes. +- If you are using a Frigate+ model and want to submit images from your dedicated LPR camera for model training and fine-tuning, annotate both the `car` and the `license_plate` in the snapshots on the Frigate+ website, even if the car is barely visible. ### Using the Secondary LPR Pipeline (Without Frigate+) diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index 26e51b616..ebce36db9 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -125,7 +125,7 @@ auth: # NOTE: The default values are for the EdgeTPU detector. # Other detectors will require the model config to be set. model: - # Required: path to the model (default: automatic based on detector) + # Required: path to the model. Frigate+ models use plus:// (default: automatic based on detector) path: /edgetpu_model.tflite # Required: path to the labelmap (default: shown below) labelmap_path: /labelmap.txt diff --git a/docs/docs/integrations/plus.md b/docs/docs/integrations/plus.md index f270f1d73..70c6ef92e 100644 --- a/docs/docs/integrations/plus.md +++ b/docs/docs/integrations/plus.md @@ -51,6 +51,8 @@ You can view all of your submitted images at [https://plus.frigate.video](https: Once you have [requested your first model](../plus/first_model.md) and gotten your own model ID, it can be used with a special model path. No other information needs to be configured for Frigate+ models because it fetches the remaining config from Frigate+ automatically. +You can either choose the new model from the Frigate+ pane in the Settings page of the Frigate UI, or manually set the model at the root level in your config: + ```yaml model: path: plus://