diff --git a/docs/data/object_detectors_models.yaml b/docs/data/object_detectors_models.yaml index 87251d6bc4..a21ae2ea7d 100644 --- a/docs/data/object_detectors_models.yaml +++ b/docs/data/object_detectors_models.yaml @@ -1276,13 +1276,13 @@ axelera: label: YOLOX-S recommended: true download: |- - The **yolox-s-coco** model is a Voyager SDK model-zoo preset (Megvii YOLOX, Apache-2.0 licensed), so no download or compilation is needed. To use a custom model, compile your ONNX model with the SDK compiler (`axcompile`) or build from the model zoo (`axzoo build yolox_s_coco --backend axrelay --cal-source repr`), then point `model.path` at the compiled model or its URL (e.g. hosted on Hugging Face). + The **yolox-s-coco-onnx** model is a Voyager SDK model-zoo preset (Megvii YOLOX, Apache-2.0 licensed), so no download or compilation is needed. To use a custom model, compile your ONNX model with the SDK compiler (`axcompile`) or build from the model zoo (`axzoo build yolox_s_coco --backend axrelay --cal-source repr`), then point `model.path` at the compiled model or its URL (e.g. hosted on Hugging Face). ui: |- Navigate to **Settings > System > Detectors and model** and select **Axelera Metis NPU** from the detector type dropdown and click **Add**. Then on the same page, in the **Custom Model** tab, configure: | Field | Value | | ---------------------------------------- | ----------------------- | - | **Custom object detector model path** | `yolox-s-coco` | + | **Custom object detector model path** | `yolox-s-coco-onnx` | | **Label map for custom object detector** | `/labelmap/coco-80.txt` | | **Object detection model input width** | `640` | | **Object detection model input height** | `640` | @@ -1296,7 +1296,7 @@ axelera: type: axelera model: - path: yolox-s-coco + path: yolox-s-coco-onnx model_type: yolo-generic width: 640 height: 640 diff --git a/docs/docs/configuration/object_detectors.md b/docs/docs/configuration/object_detectors.md index 83c74ff4fd..046c6363f1 100644 --- a/docs/docs/configuration/object_detectors.md +++ b/docs/docs/configuration/object_detectors.md @@ -797,7 +797,7 @@ See the [installation docs](../frigate/installation.md#axelera-metis) for inform ### Configuration {#configuration-axelera} -The integration runs inference through a single stream created with `create_inference_stream(network=...)`, which accepts a compiled model as a URL (downloaded into the model cache), a local file path, or an SDK model-zoo preset name. When no model is specified, the SDK model-zoo preset `yolox-s-coco` is used (no download); it can also be selected explicitly with `model.path: yolox-s-coco`. +The integration runs inference through a single stream created with `create_inference_stream(network=...)`, which accepts a compiled model as a URL (downloaded into the model cache), a local file path, or an SDK model-zoo preset name. When no model is specified, the SDK model-zoo preset `yolox-s-coco-onnx` is used (no download); it can also be selected explicitly with `model.path: yolox-s-coco-onnx`. @@ -813,7 +813,7 @@ The Metis board needs models compiled for its architecture. Compile them from th The Metis board runs models compiled for its architecture (`.axm` files, or a compiled model directory). Two options are available: -- **SDK model-zoo preset (no compilation or download needed):** the `yolox-s-coco` preset ships with the Voyager SDK (YOLOX, Megvii, Apache-2.0 licensed). Select it with `model.path: yolox-s-coco`. +- **SDK model-zoo preset (no compilation or download needed):** the `yolox-s-coco-onnx` preset ships with the Voyager SDK (YOLOX, Megvii, Apache-2.0 licensed). Select it with `model.path: yolox-s-coco-onnx`. - **Compiled model:** build one with the SDK tooling, e.g. `axzoo build yolox_s_coco --backend axrelay --cal-source repr` (model zoo) or `axcompile -i model.onnx -o compiled/` (custom ONNX). See [Building a model](/frigate/installation#building-a-model). -Host the compiled model somewhere Frigate can reach (a local path or an HTTP URL, e.g. on Hugging Face) and point `model.path` at it. With no `model.path`, the detector uses the SDK model-zoo preset `yolox-s-coco` by default (no download). Set `model.width` and `model.height` to the compiled model's input size. +Host the compiled model somewhere Frigate can reach (a local path or an HTTP URL, e.g. on Hugging Face) and point `model.path` at it. With no `model.path`, the detector uses the SDK model-zoo preset `yolox-s-coco-onnx` by default (no download). Set `model.width` and `model.height` to the compiled model's input size. diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 90c623310b..6aa4191b35 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -519,7 +519,7 @@ Then install the Metis kernel driver, for example with `axdevice driver --instal #### Building a model -Detector models are compiled for the Metis architecture. The simplest path needs no compilation: the detector uses the `yolox-s-coco` model-zoo preset by default, which ships with the SDK. +Detector models are compiled for the Metis architecture. The simplest path needs no compilation: the detector uses the `yolox-s-coco-onnx` model-zoo preset by default, which ships with the SDK. To compile your own ONNX model, use the SDK compiler (`axcompile`, see the [Compiler CLI reference](https://docs.axelera.ai/sdk/reference/compiler/compiler-cli)): diff --git a/frigate/detectors/plugins/axelera.py b/frigate/detectors/plugins/axelera.py index 7d438818c3..ff7bbbe4a7 100644 --- a/frigate/detectors/plugins/axelera.py +++ b/frigate/detectors/plugins/axelera.py @@ -16,9 +16,9 @@ model compilation across frames. Model configuration follows the hardware-backend convention: - `model.path` = URL (downloaded to the model cache) | local file path | SDK - model-zoo preset name (e.g. ``yolox-s-coco``). When omitted, the SDK + model-zoo preset name (e.g. ``yolox-s-coco-onnx``). When omitted, the SDK model-zoo preset ``AX_DEFAULT_NETWORK`` (YOLOX, Apache-2.0 licensed) is - used; use `model.path: yolox-s-coco` to select it explicitly. + used; use `model.path: yolox-s-coco-onnx` to select it explicitly. - `model.labelmap_path` / `model.labelmap`: labels are mapped to class ids BY NAME via the merged labelmap, independent of label ordering. - `model.width` / `model.height`: input frame dimensions for the network. @@ -46,7 +46,7 @@ DETECTOR_KEY = "axelera" # Default SDK model-zoo preset used when no `model.path` is given. # YOLOX (Megvii) is Apache-2.0 licensed; Ultralytics YOLO models are AGPL-3.0 # and cannot be referenced by Frigate (MIT), see blakeblackshear/frigate#10717. -AX_DEFAULT_NETWORK = "yolox-s-coco" +AX_DEFAULT_NETWORK = "yolox-s-coco-onnx" # Optional download URL for a compiled default model. When empty the SDK # model-zoo preset AX_DEFAULT_NETWORK is used instead (no download needed).