diff --git a/docs/docs/frigate/glossary.md b/docs/docs/frigate/glossary.md index bd039554c..5bfbfafa5 100644 --- a/docs/docs/frigate/glossary.md +++ b/docs/docs/frigate/glossary.md @@ -66,4 +66,4 @@ The time period starting when a tracked object entered the frame and ending when ## Zone -Zones are areas of interest, zones can be used for notifications and for limiting the areas where Frigate will create an [event](#event). [See the zone docs for more info](/configuration/zones) +Zones are areas of interest, zones can be used for notifications and for limiting the areas where Frigate will create a [review item](#review-item). [See the zone docs for more info](/configuration/zones) diff --git a/docs/docs/frigate/updating.md b/docs/docs/frigate/updating.md index 08ab863ae..95ba5b67c 100644 --- a/docs/docs/frigate/updating.md +++ b/docs/docs/frigate/updating.md @@ -56,7 +56,7 @@ If you’re running Frigate via Docker (recommended method), follow these steps: ```bash docker compose up -d ``` - - If using `docker run`, re-run your original command (e.g., from the [Installation](#docker) section) with the updated image tag. + - If using `docker run`, re-run your original command (e.g., from the [Installation](./installation.md#docker) section) with the updated image tag. 4. **Verify the Update**: - Check the container logs to ensure Frigate starts successfully: diff --git a/docs/docs/integrations/plus.md b/docs/docs/integrations/plus.md index 0a2b7f2d0..30c69c927 100644 --- a/docs/docs/integrations/plus.md +++ b/docs/docs/integrations/plus.md @@ -43,7 +43,7 @@ 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 [improving your model](../plus/improving_model.md). +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). ![Annotate](/img/annotate.png) diff --git a/docs/docs/plus/improving_model.md b/docs/docs/plus/annotating.md similarity index 56% rename from docs/docs/plus/improving_model.md rename to docs/docs/plus/annotating.md index 578f4512c..3e215faac 100644 --- a/docs/docs/plus/improving_model.md +++ b/docs/docs/plus/annotating.md @@ -1,17 +1,9 @@ --- -id: improving_model -title: Improving your model +id: annotating +title: Annotating your images --- -You may find that Frigate+ models result in more false positives initially, but by submitting true and false positives, the model will improve. With all the new images now being submitted by subscribers, future base models will improve as more and more examples are incorporated. Note that only images with at least one verified label will be used when training your model. Submitting an image from Frigate as a true or false positive will not verify the image. You still must verify the image in Frigate+ in order for it to be used in training. - -- **Submit both true positives and false positives**. This will help the model differentiate between what is and isn't correct. You should aim for a target of 80% true positive submissions and 20% false positives across all of your images. If you are experiencing false positives in a specific area, submitting true positives for any object type near that area in similar lighting conditions will help teach the model what that area looks like when no objects are present. -- **Lower your thresholds a little in order to generate more false/true positives near the threshold value**. For example, if you have some false positives that are scoring at 68% and some true positives scoring at 72%, you can try lowering your threshold to 65% and submitting both true and false positives within that range. This will help the model learn and widen the gap between true and false positive scores. -- **Submit diverse images**. For the best results, you should provide at least 100 verified images per camera. Keep in mind that varying conditions should be included. You will want images from cloudy days, sunny days, dawn, dusk, and night. As circumstances change, you may need to submit new examples to address new types of false positives. For example, the change from summer days to snowy winter days or other changes such as a new grill or patio furniture may require additional examples and training. - -## Properly labeling images - -For the best results, follow the following guidelines. +For the best results, follow these guidelines. You may also want to review the documentation on [improving your model](./index.md#improving-your-model). **Label every object in the image**: It is important that you label all objects in each image before verifying. If you don't label a car for example, the model will be taught that part of the image is _not_ a car and it will start to get confused. You can exclude labels that you don't want detected on any of your cameras. @@ -25,9 +17,17 @@ For the best results, follow the following guidelines. ![Fedex Logo](/img/plus/fedex-logo.jpg) +## AI suggested labels + +If you have an active Frigate+ subscription, new uploads will be scanned for the objects configured for you camera and you will see suggested labels as light blue boxes when annotating in Frigate+. These suggestions are processed via a queue and typically complete within a minute after uploading, but processing times can be longer. + +![Suggestions](/img/plus/suggestions.webp) + +Suggestions are converted to labels when saving, so you should remove any errant suggestions. There is already some logic designed to avoid duplicate labels, but you may still occasionally see some duplicate suggestions. You should keep the most accurate bounding box and delete any duplicates so that you have just one label per object remaining. + ## False positive labels -False positives will be shown with a read box and the label will have a strike through. +False positives will be shown with a read box and the label will have a strike through. These can't be adjusted, but they can be deleted if you accidentally submit a true positive as a false positive from Frigate. ![false positive](/img/plus/false-positive.jpg) Misidentified objects should have a correct label added. For example, if a person was mistakenly detected as a cat, you should submit it as a false positive in Frigate and add a label for the person. The boxes will overlap. diff --git a/docs/docs/plus/first_model.md b/docs/docs/plus/first_model.md index 2a0096e31..7e483d402 100644 --- a/docs/docs/plus/first_model.md +++ b/docs/docs/plus/first_model.md @@ -9,7 +9,7 @@ Before requesting your first model, you will need to upload and verify at least It is recommended to submit **both** true positives and false positives. This will help the model differentiate between what is and isn't correct. You should aim for a target of 80% true positive submissions and 20% false positives across all of your images. If you are experiencing false positives in a specific area, submitting true positives for any object type near that area in similar lighting conditions will help teach the model what that area looks like when no objects are present. -For more detailed recommendations, you can refer to the docs on [improving your model](./improving_model.md). +For more detailed recommendations, you can refer to the docs on [annotating](./annotating.md). ## Step 2: Submit a model request diff --git a/docs/docs/plus/index.md b/docs/docs/plus/index.md index e0c984f02..7666e9983 100644 --- a/docs/docs/plus/index.md +++ b/docs/docs/plus/index.md @@ -40,9 +40,17 @@ Using Frigate+ models with `onnx` and `rocm` is only available with Frigate 0.15 _\* Requires Frigate 0.15_ +## Improving your model + +Some users may find that Frigate+ models result in more false positives initially, but by submitting true and false positives, the model will improve. With all the new images now being submitted by subscribers, future base models will improve as more and more examples are incorporated. Note that only images with at least one verified label will be used when training your model. Submitting an image from Frigate as a true or false positive will not verify the image. You still must verify the image in Frigate+ in order for it to be used in training. + +- **Submit both true positives and false positives**. This will help the model differentiate between what is and isn't correct. You should aim for a target of 80% true positive submissions and 20% false positives across all of your images. If you are experiencing false positives in a specific area, submitting true positives for any object type near that area in similar lighting conditions will help teach the model what that area looks like when no objects are present. +- **Lower your thresholds a little in order to generate more false/true positives near the threshold value**. For example, if you have some false positives that are scoring at 68% and some true positives scoring at 72%, you can try lowering your threshold to 65% and submitting both true and false positives within that range. This will help the model learn and widen the gap between true and false positive scores. +- **Submit diverse images**. For the best results, you should provide at least 100 verified images per camera. Keep in mind that varying conditions should be included. You will want images from cloudy days, sunny days, dawn, dusk, and night. As circumstances change, you may need to submit new examples to address new types of false positives. For example, the change from summer days to snowy winter days or other changes such as a new grill or patio furniture may require additional examples and training. + ## Available label types -Frigate+ models support a more relevant set of objects for security cameras. Currently, the following objects are supported: +Frigate+ models support a more relevant set of objects for security cameras. The labels for annotation in Frigate+ are configurable by editing the camera in the Cameras section of Frigate+. Currently, the following objects are supported: - **People**: `person`, `face` - **Vehicles**: `car`, `motorcycle`, `bicycle`, `boat`, `license_plate` @@ -52,6 +60,16 @@ Frigate+ models support a more relevant set of objects for security cameras. Cur Other object types available in the default Frigate model are not available. Additional object types will be added in future releases. +### Candidate labels + +Candidate labels are also available for annotation. These labels don't have enough data to be included in the model yet, but using them will help add support sooner. You can enable these labels by editing the camera settings. + +Where possible, these labels are mapped to existing labels during training. For example, any `baby` labels are mapped to `person` until support for new labels is added. + +The candidate labels are: `baby`, `royal mail`, `canada post`, `bpost`, `skunk`, `badger`, `possum`, `rodent`, `kangaroo`, `chicken`, `groundhog`, `boar`, `hedgehog`, `school bus`, `tractor`, `golf cart`, `garbage truck`, `bus`, `sports ball` + +Candidate labels are not available for automatic suggestions. + ### Label attributes Frigate has special handling for some labels when using Frigate+ models. `face`, `license_plate`, and delivery logos such as `amazon`, `ups`, and `fedex` are considered attribute labels which are not tracked like regular objects and do not generate review items directly. In addition, the `threshold` filter will have no effect on these labels. You should adjust the `min_score` and other filter values as needed. diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 6c6e2be66..bdc8e7fa7 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -23,10 +23,22 @@ const config: Config = { mermaid: true, }, themeConfig: { - algolia: { - appId: "WIURGBNBPY", - apiKey: "d02cc0a6a61178b25da550212925226b", - indexName: "frigate", + announcementBar: { + id: 'frigate_plus', + content: ` + 🚀 + Get more relevant and accurate detections with Frigate+ models. + Learn more + ✨ + `, + backgroundColor: '#005f73', + textColor: '#e0fbfc', + isCloseable: false, }, docs: { sidebar: { diff --git a/docs/sidebars.ts b/docs/sidebars.ts index cd662f239..7007bb0f0 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -87,8 +87,8 @@ const sidebars: SidebarsConfig = { ], 'Frigate+': [ 'plus/index', + 'plus/annotating', 'plus/first_model', - 'plus/improving_model', 'plus/faq', ], Troubleshooting: [ diff --git a/docs/static/img/plus/suggestions.webp b/docs/static/img/plus/suggestions.webp new file mode 100644 index 000000000..274eda790 Binary files /dev/null and b/docs/static/img/plus/suggestions.webp differ