From 63f9689b0e858ed5314cae550d359353dd95e4cd Mon Sep 17 00:00:00 2001 From: "Thomas A." Date: Sat, 24 May 2025 17:42:32 +0200 Subject: [PATCH] Improve documentation for YOLO-NAS notebook (#18381) * Add readme file for notebooks It took me quite some time to find out this workbook opens in Google Colab, so i though it may help someone else to have this visible in the folder aswell. * Add explicit link to Google Colab for YOLO-NAS --- docs/docs/configuration/object_detectors.md | 2 +- notebooks/README.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 notebooks/README.md diff --git a/docs/docs/configuration/object_detectors.md b/docs/docs/configuration/object_detectors.md index ae497b41d..32ca7bed4 100644 --- a/docs/docs/configuration/object_detectors.md +++ b/docs/docs/configuration/object_detectors.md @@ -1024,7 +1024,7 @@ x.export() ### Downloading YOLO-NAS Model -You can build and download a compatible model with pre-trained weights using [this notebook](https://github.com/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb). +You can build and download a compatible model with pre-trained weights using [this notebook](https://github.com/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb) which can be run directly in [Google Colab](https://colab.research.google.com/github/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb). :::warning diff --git a/notebooks/README.md b/notebooks/README.md new file mode 100644 index 000000000..23afa6e5d --- /dev/null +++ b/notebooks/README.md @@ -0,0 +1,10 @@ +# Notebooks + +## YOLO-NAS Pretrained + +You can build and download a compatible model with pre-trained weights using [Google Colab](https://colab.research.google.com/github/blakeblackshear/frigate/blob/dev/notebooks/YOLO_NAS_Pretrained_Export.ipynb). + +> [!WARNING] +> The pre-trained YOLO-NAS weights from DeciAI are subject to their license and can't be used commercially. For more information, see: https://docs.deci.ai/super-gradients/latest/LICENSE.YOLONAS.html + +The input image size in this notebook is set to 320x320. This results in lower CPU usage and faster inference times without impacting performance in most cases due to the way Frigate crops video frames to areas of interest before running detection. The notebook and config can be updated to 640x640 if desired. By default, YOLO_NAS_S is built with YOLO_NAS_M and YOLO_NAS_L sizes also being available for export. \ No newline at end of file