From e7ad38d8274ceb99b4f4412c1c4d6a858065d895 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 2 Jan 2025 10:04:16 -0600 Subject: [PATCH] Update model docs (#15779) --- docs/docs/configuration/object_detectors.md | 7 ++++++- docs/docs/configuration/reference.md | 14 ++++++++------ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/docs/configuration/object_detectors.md b/docs/docs/configuration/object_detectors.md index 5982da2ec8..e06baaad54 100644 --- a/docs/docs/configuration/object_detectors.md +++ b/docs/docs/configuration/object_detectors.md @@ -144,7 +144,9 @@ detectors: #### SSDLite MobileNet v2 -An OpenVINO model is provided in the container at `/openvino-model/ssdlite_mobilenet_v2.xml` and is used by this detector type by default. The model comes from Intel's Open Model Zoo [SSDLite MobileNet V2](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/ssdlite_mobilenet_v2) and is converted to an FP16 precision IR model. Use the model configuration shown below when using the OpenVINO detector with the default model. +An OpenVINO model is provided in the container at `/openvino-model/ssdlite_mobilenet_v2.xml` and is used by this detector type by default. The model comes from Intel's Open Model Zoo [SSDLite MobileNet V2](https://github.com/openvinotoolkit/open_model_zoo/tree/master/models/public/ssdlite_mobilenet_v2) and is converted to an FP16 precision IR model. + +Use the model configuration shown below when using the OpenVINO detector with the default OpenVINO model: ```yaml detectors: @@ -254,6 +256,7 @@ yolov4x-mish-640 yolov7-tiny-288 yolov7-tiny-416 yolov7-640 +yolov7-416 yolov7-320 yolov7x-640 yolov7x-320 @@ -282,6 +285,8 @@ The TensorRT detector can be selected by specifying `tensorrt` as the model type The TensorRT detector uses `.trt` model files that are located in `/config/model_cache/tensorrt` by default. These model path and dimensions used will depend on which model you have generated. +Use the config below to work with generated TRT models: + ```yaml detectors: tensorrt: diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index 626e4f3c82..7f31643690 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -117,25 +117,27 @@ auth: hash_iterations: 600000 # Optional: model modifications +# NOTE: The default values are for the EdgeTPU detector. +# Other detectors will require the model config to be set. model: - # Optional: path to the model (default: automatic based on detector) + # Required: path to the model (default: automatic based on detector) path: /edgetpu_model.tflite - # Optional: path to the labelmap (default: shown below) + # Required: path to the labelmap (default: shown below) labelmap_path: /labelmap.txt # Required: Object detection model input width (default: shown below) width: 320 # Required: Object detection model input height (default: shown below) height: 320 - # Optional: Object detection model input colorspace + # Required: Object detection model input colorspace # Valid values are rgb, bgr, or yuv. (default: shown below) input_pixel_format: rgb - # Optional: Object detection model input tensor format + # Required: Object detection model input tensor format # Valid values are nhwc or nchw (default: shown below) input_tensor: nhwc - # Optional: Object detection model type, currently only used with the OpenVINO detector + # Required: Object detection model type, currently only used with the OpenVINO detector # Valid values are ssd, yolox, yolonas (default: shown below) model_type: ssd - # Optional: Label name modifications. These are merged into the standard labelmap. + # Required: Label name modifications. These are merged into the standard labelmap. labelmap: 2: vehicle # Optional: Map of object labels to their attribute labels (default: depends on model)