administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-17 16:44:29 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs tweaks

Browse Source
This commit is contained in:
Josh Hawkins 2024-11-05 07:32:48 -06:00
parent 876aaf2e77
commit 6588abcc6f
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/configuration/semantic_search.md
View File

@ -41,7 +41,7 @@ The vision model is able to embed both images and text into the same vector spac
The text model is used to embed tracked object descriptions and perform searches against them. Descriptions can be created, viewed, and modified on the Search page when clicking on the gray tracked object chip at the top left of each review item. See [the Generative AI docs](/configuration/genai.md) for more information on how to automatically generate tracked object descriptions. The text model is used to embed tracked object descriptions and perform searches against them. Descriptions can be created, viewed, and modified on the Search page when clicking on the gray tracked object chip at the top left of each review item. See [the Generative AI docs](/configuration/genai.md) for more information on how to automatically generate tracked object descriptions.
Differently weighted CLIP models are available and can be selected by setting the `model_size` config option: Differently weighted CLIP models are available and can be selected by setting the `model_size` config option as `small` or `large`:
```yaml ```yaml
semantic_search: semantic_search:
@ -50,7 +50,7 @@ semantic_search:
``` ```
- Configuring the `large` model employs the full Jina model and will automatically run on the GPU if applicable. - Configuring the `large` model employs the full Jina model and will automatically run on the GPU if applicable.
- Configuring the `small` model employs a quantized version of the model that uses much less RAM and runs faster on CPU with a very negligible difference in embedding quality. - Configuring the `small` model employs a quantized version of the model that uses less RAM and runs on CPU with a very negligible difference in embedding quality.
### GPU Acceleration ### GPU Acceleration
@ -63,9 +63,11 @@ If the correct build is used for your GPU and the `large` model is configured, t
**NOTE:** Object detection and Semantic Search are independent features. If you want to use your GPU with Semantic Search, you must choose the appropriate Frigate Docker image for your GPU. **NOTE:** Object detection and Semantic Search are independent features. If you want to use your GPU with Semantic Search, you must choose the appropriate Frigate Docker image for your GPU.
- **AMD** - **AMD**
- ROCm will automatically be detected and used for semantic search in the `-rocm` Frigate image. - ROCm will automatically be detected and used for semantic search in the `-rocm` Frigate image.
- **Intel** - **Intel**
- OpenVINO will automatically be detected and used for semantic search in the default Frigate image. - OpenVINO will automatically be detected and used for semantic search in the default Frigate image.
- **Nvidia** - **Nvidia**
@ -74,12 +76,6 @@ If the correct build is used for your GPU and the `large` model is configured, t
::: :::
```yaml
semantic_search:
enabled: True
model_size: small
```
## Usage and Best Practices ## Usage and Best Practices
1. Semantic search is used in conjunction with the other filters available on the Search page. Use a combination of traditional filtering and semantic search for the best results. 1. Semantic search is used in conjunction with the other filters available on the Search page. Use a combination of traditional filtering and semantic search for the best results.