Skip to content

Commit 7c71bb5

Browse files
committed
complete the example config and fix a misleading option in the app docs
Five options existed only in the README table, not in the file people copy. match_top_k was listed as an app option although it is set on the Settings tab.
1 parent 4abcc57 commit 7c71bb5

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

docs/example-config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ faceid:
2727
# correct recognitions over 3 with no misassignments.
2828
match_top_k: 3
2929
max_faces_per_person: 40 # soft cap; the most redundant photo is set aside
30+
trimmed_keep: 10 # how many set-aside photos to keep per person (0 = delete)
31+
dedupe_threshold: 0.65 # default sensitivity of the "remove duplicates" action
32+
hires_enroll: true # fetch review-queue faces from the recording instead of
33+
# the detect snapshot — typically twice the face size
34+
ignore_threshold: 0.50 # similarity at which a face counts as ignored
35+
# (defaults to match_threshold when unset)
36+
ignore_learning: true # learn new looks of ignored people as extra anchors
3037
min_face_px: 48 # minimum face size in the snapshot (pixels)
3138
det_size: 640 # detection input size (higher = better far faces, slower)
3239
max_attempts: 6 # recognition attempts per Frigate event

faceid-addon/DOCS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,14 @@ Full documentation: https://github.com/SkyTechNerds/faceid
3737
| `dedupe_threshold` | default sensitivity for the Settings "Remove duplicates" action |
3838
| `hires_enroll` | fetch new review-queue faces from the recording instead of the detect snapshot (sharper references) |
3939
| `poll_interval` | seconds; >0 also polls Frigate's event API for events MQTT never announces (e.g. events created by an automation from a camera's own detection). 0 = off |
40-
| `match_top_k` | a match score is the mean of this many best-fitting reference photos. Higher resists a single lucky photo; lower helps people whose references cover many angles |
4140
| `backup_enabled` / `backup_hour` / `backup_keep` | optional built-in daily gallery backup |
4241

4342
Thresholds and backup can also be changed live on the app's **Settings** tab; those
44-
edits are stored in the app's data volume and override these options.
43+
edits are stored in the app's data volume and override these options. The Settings tab
44+
additionally holds **"photos averaged per match"** (`match_top_k`) — a match score is the
45+
mean of that many best-fitting reference photos. Higher resists a single lucky photo;
46+
lower helps people whose references cover many different angles, since their own less
47+
similar photos otherwise drag the mean down.
4548

4649
Face data (gallery, review queue) is stored in the app's data volume and survives
4750
updates. Uninstalling the app deletes it.

0 commit comments

Comments
 (0)