mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-09-30 20:06:51 +03:00
Josh HawkinsandGitHub
7413ce08d4
* add embedded mode to BaseSection so parents can host the save action * add optional action slot to current Frigate+ model summary * add w-full to action slot flex wrapper for explicit width contract * i18n * merged detectors and model settings view * fix document title * Embed detector form in merged settings view * add detection model card with tabs and custom model embed * add Frigate+ model selector with filter popover to merged page * Add mismatch banner and gate save on detector and model compatibility * Wire atomic save, restart toast, and undo on detectors and model page * Clear child pending data on undo * route merged detectors and model view in settings * trim Frigate+ page to account-only and remove old detection model view * basic e2e * Fix unsaved-changes guard, custom path leak, and post-failure cache resync * Rename to Detectors and model, float Modified badge, use ConfigMessageBanner for mismatch * Hide Plus/Custom tabs when Frigate+ is not enabled * Detect active Plus model via model.plus.id instead of path prefix * Sync state back to snapshot when child form un-modifies and remount on undo * Always require restart on save since model changes also need one * Wrap Frigate+ model selector in SplitCardRow with label and description * rename tab * update docs * sync top-level model with default detector's resolved model when the user doesn't define a top-level `model:` block, `FrigateConfig.model` stayed at pydantic field defaults (320×320, /labelmap.txt) while the per-detector model picked up `DEFAULT_MODEL` for openvino on cpu (300×300, coco_91cl_bkgr.txt introduced in #23127), causing `RemoteObjectDetector` to fail with "buffer is too small for requested array" because the SHM was sized from the per-detector model but mapped using the top-level one. After the detector loop, copy the first detector's resolved model up to `self.model` so both sides agree on dimensions and labelmap * revert to cpu detector by default use openvino cpu for new configs only * add defaults
89 lines
3.1 KiB
Markdown
89 lines
3.1 KiB
Markdown
---
|
|
id: plus
|
|
title: Frigate+
|
|
---
|
|
|
|
import NavPath from "@site/src/components/NavPath";
|
|
|
|
For more information about how to use Frigate+ to improve your model, see the [Frigate+ docs](/plus/).
|
|
|
|
:::info
|
|
|
|
Frigate+ requires an active internet connection to communicate with `https://api.frigate.video` for model downloads, image uploads, and annotations. See [Network Requirements](/frigate/network_requirements#frigate) for details.
|
|
|
|
:::
|
|
|
|
## 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.
|
|
|
|
|
|
|
|
### Set your API key
|
|
|
|
In Frigate, you can use an environment variable or a docker secret named `PLUS_API_KEY` to enable the `Frigate+` buttons on the Explore page. Home Assistant App users can set it under Settings > Apps > Frigate > Configuration > Options (be sure to toggle the "Show unused optional configuration options" switch).
|
|
|
|
:::warning
|
|
|
|
You cannot use the `environment_vars` section of your Frigate configuration file to set this environment variable. It must be defined as an environment variable in the docker config or Home Assistant App config.
|
|
|
|
:::
|
|
|
|
## Submit examples
|
|
|
|
Once your API key is configured, you can submit examples directly from the Explore page in Frigate. From the More Filters menu, select "Has a Snapshot - Yes" and "Submitted to Frigate+ - No", and press Apply at the bottom of the pane. Then, click on a thumbnail and select the Snapshot tab.
|
|
|
|
You can use your keyboard's left and right arrow keys to quickly navigate between the tracked object snapshots.
|
|
|
|
:::note
|
|
|
|
Snapshots must be enabled to be able to submit examples to Frigate+
|
|
|
|
:::
|
|
|
|
|
|
|
|
### 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. For more detailed information about labeling, see the documentation on [annotating](../plus/annotating.md).
|
|
|
|
|
|
|
|
## Use Models
|
|
|
|
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 <NavPath path="Settings > System > Detectors and model" /> pane in the Frigate UI (the **Frigate+ Model** tab), or manually set the model at the root level in your config:
|
|
|
|
```yaml
|
|
detectors: ...
|
|
|
|
model:
|
|
path: plus://<your_model_id>
|
|
```
|
|
|
|
:::note
|
|
|
|
Model IDs are not secret values and can be shared freely. Access to your model is protected by your API key.
|
|
|
|
:::
|
|
|
|
Models are downloaded into the `/config/model_cache` folder and only downloaded if needed.
|
|
|
|
If needed, you can override the labelmap for Frigate+ models. This is not recommended as renaming labels will break the Submit to Frigate+ feature if the labels are not available in Frigate+.
|
|
|
|
```yaml
|
|
model:
|
|
path: plus://<your_model_id>
|
|
labelmap:
|
|
3: animal
|
|
4: animal
|
|
5: animal
|
|
```
|