From 99b4dc8725637a48d40be6dc71e0c1eb381c4365 Mon Sep 17 00:00:00 2001 From: Maximilian McDiarmid <76010421+fakevoxel@users.noreply.github.com> Date: Tue, 22 Apr 2025 16:27:53 -0400 Subject: [PATCH] Updates to object detection documentation (#1930) ## Description Added a warning about non-quantized custom models not being supported, and a note about not being able to delete models from the GUI once they're uploaded to the coprocessor. --------- Co-authored-by: Sam Freund --- .../source/docs/objectDetection/about-object-detection.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/docs/objectDetection/about-object-detection.md b/docs/source/docs/objectDetection/about-object-detection.md index 40ee828ae..a155a2f98 100644 --- a/docs/source/docs/objectDetection/about-object-detection.md +++ b/docs/source/docs/objectDetection/about-object-detection.md @@ -47,9 +47,17 @@ Before beginning, it is necessary to install the [rknn-toolkit2](https://github. PhotonVision currently ONLY supports 640x640 Ultralytics YOLOv5, YOLOv8, and YOLOv11 models trained and converted to `.rknn` format for RK3588 CPUs! Other models require different post-processing code and will NOT work. The model conversion process is also highly particular. Proceed with care. ::: +:::{warning} +Non-quantized models are not supported! If you have the option, make sure quantization is enabled when exporting to .rknn format. This will represent the weights and activations of the model as 8-bit integers, instead of 32-bit floats which PhotonVision doesn't support. Quantized models are also much faster. +::: + In the settings, under `Device Control`, there's an option to upload a new object detection model. Naming convention should be `name-verticalResolution-horizontalResolution-yolovXXX`. The `name` should only include alphanumeric characters, periods, and underscores. Additionally, the labels file ought to have the same name as the RKNN file, with `-labels` appended to the end. For example, if the RKNN file is named `Algae_1.03.2025-640-640-yolov5s.rknn`, the labels file should be named `Algae_1.03.2025-640-640-yolov5s-labels.txt`. + +:::{note} +Currently there is no way to delete custom models in the GUI, though this is a planned feature. To do this, you have to SSH into the coprocessor and delete the files manually from `/opt/photonvision/photonvision_config/models`. +:::