diff --git a/docs/docs/plus/index.md b/docs/docs/plus/index.md index eba9bc370..ba52fb713 100644 --- a/docs/docs/plus/index.md +++ b/docs/docs/plus/index.md @@ -11,34 +11,51 @@ Information on how to integrate Frigate+ with Frigate can be found in the [integ ## Available model types -There are two model types offered in Frigate+, `mobiledet` and `yolonas`. Both of these models are object detection models and are trained to detect the same set of labels [listed below](#available-label-types). +There are three model types offered in Frigate+, `mobiledet`, `yolonas`, and `yolov9`. All of these models are object detection models and are trained to detect the same set of labels [listed below](#available-label-types). Not all model types are supported by all detectors, so it's important to choose a model type to match your detector as shown in the table under [supported detector types](#supported-detector-types). You can test model types for compatibility and speed on your hardware by using the base models. -| Model Type | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `mobiledet` | Based on the same architecture as the default model included with Frigate. Runs on Google Coral devices and CPUs. | -| `yolonas` | A newer architecture that offers slightly higher accuracy and improved detection of small objects. Runs on Intel, NVidia GPUs, and AMD GPUs. | +| Model Type | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `mobiledet` | Based on the same architecture as the default model included with Frigate. Runs on Google Coral devices and CPUs. | +| `yolonas` | A newer architecture that offers slightly higher accuracy and improved detection of small objects. Runs on Intel, NVidia GPUs, and AMD GPUs. | +| `yolov9` | A leading SOTA (state of the art) object detection model with similar performance to yolonas, but on a wider range of hardware options. Runs on Intel, NVidia GPUs, AMD GPUs, Hailo, MemryX\*, and Rockchip NPUs. | + +_\* Support coming in 0.17_ + +### YOLOv9 Details + +YOLOv9 models are available in `s` and `t` sizes. When requesting a `yolov9` model, you will be prompted to choose a size. If you are unsure what size to choose, you should perform some tests with the base models to find the performance level that suits you. The `s` size is most similar to the current `yolonas` models in terms of inference times and accuracy, and a good place to start is the `320x320` resolution model for `yolov9s`. + +:::info + +When switching to YOLOv9, you may need to adjust your thresholds for some objects. + +::: + +#### Hailo Support + +If you have a Hailo device, you will need to specify the hardware you have when submitting a model request because they are not cross compatible. Please test using the available base models before submitting your model request. + +#### Rockchip (RKNN) Support + +For 0.16, YOLOv9 onnx models will need to be manually converted. First, you will need to configure Frigate to use the model id for your YOLOv9 onnx model so it downloads the model to your `model_cache` directory. From there, you can follow the [documentation](/configuration/object_detectors.md#converting-your-own-onnx-model-to-rknn-format) to convert it. Automatic conversion is coming in 0.17. ## Supported detector types -Currently, Frigate+ models support CPU (`cpu`), Google Coral (`edgetpu`), OpenVino (`openvino`), and ONNX (`onnx`) detectors. - -:::warning - -Using Frigate+ models with `onnx` is only available with Frigate 0.15 and later. - -::: +Currently, Frigate+ models support CPU (`cpu`), Google Coral (`edgetpu`), OpenVino (`openvino`), ONNX (`onnx`), Hailo (`hailo8l`), and Rockchip\* (`rknn`) detectors. | Hardware | Recommended Detector Type | Recommended Model Type | | -------------------------------------------------------------------------------- | ------------------------- | ---------------------- | | [CPU](/configuration/object_detectors.md#cpu-detector-not-recommended) | `cpu` | `mobiledet` | | [Coral (all form factors)](/configuration/object_detectors.md#edge-tpu-detector) | `edgetpu` | `mobiledet` | -| [Intel](/configuration/object_detectors.md#openvino-detector) | `openvino` | `yolonas` | -| [NVidia GPU](/configuration/object_detectors#onnx)\* | `onnx` | `yolonas` | -| [AMD ROCm GPU](/configuration/object_detectors#amdrocm-gpu-detector)\* | `rocm` | `yolonas` | +| [Intel](/configuration/object_detectors.md#openvino-detector) | `openvino` | `yolov9` | +| [NVidia GPU](/configuration/object_detectors#onnx) | `onnx` | `yolov9` | +| [AMD ROCm GPU](/configuration/object_detectors#amdrocm-gpu-detector) | `rocm` | `yolov9` | +| [Hailo8/Hailo8L/Hailo8R](/configuration/object_detectors#hailo-8) | `hailo8l` | `yolov9` | +| [Rockchip NPU](/configuration/object_detectors#rockchip-platform)\* | `rknn` | `yolov9` | -_\* Requires Frigate 0.15_ +_\* Requires manual conversion in 0.16. Automatic conversion coming in 0.17._ ## Improving your model