From 709a306c8c8425faf9b7def74755af4634de5bfb Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Tue, 25 Mar 2025 17:51:01 -0600 Subject: [PATCH] Add docs for bird classification --- .../docs/configuration/bird_classification.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/docs/configuration/bird_classification.md diff --git a/docs/docs/configuration/bird_classification.md b/docs/docs/configuration/bird_classification.md new file mode 100644 index 000000000..172a2031b --- /dev/null +++ b/docs/docs/configuration/bird_classification.md @@ -0,0 +1,27 @@ +--- +id: bird_classification +title: Bird Classification +--- + +Bird classification identifies known bird using a quantized inat bird tensorflow model. When a known bird is recognized, its common name will be added as a `sub_label`. This information is included in the UI, filters, as well as in notifications. + +## Minimum System Requirements + +Bird classification runs a lightweight tflite model on the CPU, there are no significantly different system requirements than running Frigate itself. + +## Configuration + +Bird classification is disabled by default, it must be enabled in your config file before it can be used. Bird classification is a global configuration setting. + +```yaml +classification: + bird: + enabled: true +``` + +## Advanced Configuration + +Fine-tune bird classification with these optional parameters: + +- `threshold`: Classification confidence score required to set the sub label on the object. + - Default: `0.9`.