From de704ef2116ee322a4397a98f670b6704c36114d Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Fri, 21 Nov 2025 11:19:20 -0700 Subject: [PATCH] Update docs with creation instructions --- .../object_classification.md | 12 ++++++++---- .../state_classification.md | 18 ++++++++++++++---- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/docs/configuration/custom_classification/object_classification.md b/docs/docs/configuration/custom_classification/object_classification.md index 72c766868..3d59b74f9 100644 --- a/docs/docs/configuration/custom_classification/object_classification.md +++ b/docs/docs/configuration/custom_classification/object_classification.md @@ -75,14 +75,18 @@ classification: ## Training the model -Creating and training the model is done within the Frigate UI using the `Classification` page. +Creating and training the model is done within the Frigate UI using the `Classification` page. The process consists of two steps: -### Getting Started +### Step 1: Name and Define + +Enter a name for your model, select the object label to classify (e.g., `person`, `dog`, `car`), choose the classification type (sub label or attribute), and define your classes. Include a `none` class for objects that don't fit any specific category. + +### Step 2: Assign Training Examples + +The system will automatically generate example images from detected objects matching your selected label. You'll be guided through each class one at a time to select which images represent that class. Any images not assigned to a specific class will automatically be assigned to `none` when you complete the last class. Once all images are processed, training will begin automatically. When choosing which objects to classify, start with a small number of visually distinct classes and ensure your training samples match camera viewpoints and distances typical for those objects. -// TODO add this section once UI is implemented. Explain process of selecting objects and curating training examples. - ### Improving the Model - **Problem framing**: Keep classes visually distinct and relevant to the chosen object types. diff --git a/docs/docs/configuration/custom_classification/state_classification.md b/docs/docs/configuration/custom_classification/state_classification.md index caaeaed5a..66d3e60ca 100644 --- a/docs/docs/configuration/custom_classification/state_classification.md +++ b/docs/docs/configuration/custom_classification/state_classification.md @@ -48,13 +48,23 @@ classification: ## Training the model -Creating and training the model is done within the Frigate UI using the `Classification` page. +Creating and training the model is done within the Frigate UI using the `Classification` page. The process consists of three steps: -### Getting Started +### Step 1: Name and Define -When choosing a portion of the camera frame for state classification, it is important to make the crop tight around the area of interest to avoid extra signals unrelated to what is being classified. +Enter a name for your model and define at least 2 classes (states) that represent mutually exclusive states. For example, `open` and `closed` for a door, or `on` and `off` for lights. -// TODO add this section once UI is implemented. Explain process of selecting a crop. +### Step 2: Select the Crop Area + +Choose one or more cameras and draw a rectangle over the area of interest for each camera. The crop should be tight around the region you want to classify to avoid extra signals unrelated to what is being classified. You can drag and resize the rectangle to adjust the crop area. + +### Step 3: Assign Training Examples + +The system will automatically generate example images from your camera feeds. You'll be guided through each class one at a time to select which images represent that state. + +**Important**: All images must be assigned to a state before training can begin. This includes images that may not be optimal, such as when people temporarily block the view, sun glare is present, or other distractions occur. Assign these images to the state that is actually present (based on what you know the state to be), not based on the distraction. This training helps the model correctly identify the state even when such conditions occur during inference. + +Once all images are assigned, training will begin automatically. ### Improving the Model