add information about frigate plus to docs (#4919)

* add information about frigate plus to docs

* Update docs/docs/integrations/plus.md

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
This commit is contained in:
Blake Blackshear 2023-01-06 06:51:40 -06:00 committed by GitHub
parent 12235acd75
commit 8410788e99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,48 @@
---
id: plus
title: Frigate+
---
:::info
Frigate+ is under active development and currently only offers the ability to submit your examples with annotations. Models will be available after enough examples are submitted to train a robust model. It is free to create an account and upload your examples.
:::
Frigate+ offers models trained from scratch and specifically designed for the way Frigate NVR analyzes video footage. They offer higher accuracy with less resources. By uploading your own labeled examples, your model can be uniquely tuned for accuracy in your specific conditions. After tuning, performance is evaluated against a broad dataset and real world examples submitted by other Frigate+ users to prevent overfitting.
Custom models also include a more relevant set of objects for security cameras such as person, face, car, license plate, delivery truck, package, dog, cat, deer, and more. Interested in detecting an object unique to you? Upload examples to incorporate your own objects without worrying that you are reducing the accuracy of other object types in the model.
## Setup
### Create an account
Free accounts can be created at [https://plus.frigate.video](https://plus.frigate.video).
### Generate an API key
Once logged in, you can generate an API key for Frigate in Settings.
![API key](/img/plus-api-key-min.png)
### Set your API key
In Frigate, you can set the `PLUS_API_KEY` environment variable to enable the `SEND TO FRIGATE+` buttons on the events page. You can set it in your Docker Compose file or in your Docker run command. Home Assistant Addon users can set it under Settings > Addons > Frigate NVR > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch).
:::caution
You cannot use the `environment_vars` section of your configuration file to set this environment variable.
:::
### Submit examples
Once your API key is configured, you can submit examples directly from the events page in Frigate using the `SEND TO FRIGATE+` button.
![Send To Plus](/img/send-to-plus.png)
### Annotate and verify
You can view all of your submitted images at [https://plus.frigate.video](https://plus.frigate.video). Annotations can be added by clicking an image.
![Annotate](/img/annotate.png)

View File

@ -33,6 +33,7 @@ module.exports = {
"configuration/ffmpeg_presets", "configuration/ffmpeg_presets",
], ],
Integrations: [ Integrations: [
"integrations/plus",
"integrations/home-assistant", "integrations/home-assistant",
"integrations/api", "integrations/api",
"integrations/mqtt", "integrations/mqtt",

BIN
docs/static/img/annotate.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
docs/static/img/plus-api-key-min.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/static/img/send-to-plus.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB