From 10155d3b3ec556ebbdb45a0304ec747340a8cfad Mon Sep 17 00:00:00 2001 From: Anil Ozyalcin Date: Thu, 16 Feb 2023 21:45:05 -0800 Subject: [PATCH] Modified documentation to mention YOLOv5 and YOLOv8 --- docs/docs/configuration/detectors.md | 3 +-- docs/docs/configuration/index.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/docs/configuration/detectors.md b/docs/docs/configuration/detectors.md index 0c19fe4b0..979fbe4d5 100644 --- a/docs/docs/configuration/detectors.md +++ b/docs/docs/configuration/detectors.md @@ -118,8 +118,7 @@ model: input_pixel_format: bgr labelmap_path: /openvino-model/coco_91cl_bkgr.txt ``` - -This detector also supports YOLOx models, and has been verified to work with the [yolox_tiny](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/yolox-tiny) model from Intel's Open Model Zoo. Frigate does not come with `yolox_tiny` model, you will need to follow [OpenVINO documentation](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/yolox-tiny) to provide your own model to Frigate. There is currently no support for other types of YOLO models (YOLOv3, YOLOv4, etc...). Below is an example of how `yolox_tiny` and other yolox variants can be used in Frigate: +This detector also supports some YOLO variants: YOLOX, YOLOv5, and YOLOv8 specifically. Other YOLO variants are not officially supported/tested. Frigate does not come with any yolo models preloaded, so you will need to supply your own models. This detector has been verified to work with the [yolox_tiny](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/yolox-tiny) model from Intel's Open Model Zoo. You can follow [these instructions](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/yolox-tiny#download-a-model-and-convert-it-into-openvino-ir-format) to retrieve the OpenVINO-compatible `yolox_tiny` model. Make sure that the model input dimensions match the `width` and `height` parameters, and `model_type` is set accordingly. See [Full Configuration Reference](index.md#full-configuration-reference) for a list of possible `model_type` options. Below is an example of how `yolox_tiny` can be used in Frigate: ```yaml detectors: diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 0fcc2d614..620ab2181 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -105,7 +105,7 @@ model: # Valid values are nhwc or nchw (default: shown below) input_tensor: nhwc # Optional: Object detection model type, currently only used with the OpenVINO detector - # Valid values are ssd or yolox (default: shown below) + # Valid values are ssd, yolox, yolov5, or yolov8 (default: shown below) model_type: ssd # Optional: Label name modifications. These are merged into the standard labelmap. labelmap: