fix: fix crashing on inference due to missing model types

Author: vietanhdev

anylabeling/configs/auto_labeling/models.yaml

@@ -1,3 +1,19 @@
+- name: "sam2.1_hiera_tiny_20260221"
+  display_name: Segment Anything 2.1 (Hiera-Tiny)
+  download_url: https://huggingface.co/vietanhdev/segment-anything-2.1-onnx-models/resolve/main/sam2.1_hiera_tiny_20260221.zip
+  type: segment_anything
+- name: "sam2.1_hiera_small_20260221"
+  display_name: Segment Anything 2.1 (Hiera-Small)
+  download_url: https://huggingface.co/vietanhdev/segment-anything-2.1-onnx-models/resolve/main/sam2.1_hiera_small_20260221.zip
+  type: segment_anything
+- name: "sam2.1_hiera_base_plus_20260221"
+  display_name: Segment Anything 2.1 (Hiera-Base+)
+  download_url: https://huggingface.co/vietanhdev/segment-anything-2.1-onnx-models/resolve/main/sam2.1_hiera_base_plus_20260221.zip
+  type: segment_anything
+- name: "sam2.1_hiera_large_20260221"
+  display_name: Segment Anything 2.1 (Hiera-Large)
+  download_url: https://huggingface.co/vietanhdev/segment-anything-2.1-onnx-models/resolve/main/sam2.1_hiera_large_20260221.zip
+  type: segment_anything
 - name: "sam2_1_coreml_large"
   display_name: Segment Anything 2.1 (Large) CoreML
   download_url: https://huggingface.co/apple/coreml-sam2.1-large
@@ -22,48 +38,64 @@
 - name: "sam2_hiera_tiny_20240803"
   display_name: Segment Anything 2 (Hiera-Tiny)
   download_url: https://huggingface.co/vietanhdev/segment-anything-2-onnx-models/resolve/main/sam2_hiera_tiny.zip
+  type: segment_anything
 - name: "sam2_hiera_small_20240803"
   display_name: Segment Anything 2 (Hiera-Small)
   download_url: https://huggingface.co/vietanhdev/segment-anything-2-onnx-models/resolve/main/sam2_hiera_small.zip
+  type: segment_anything
 - name: "sam2_hiera_base_plus_20240803"
   display_name: Segment Anything 2 (Hiera-Base+)
   download_url: https://huggingface.co/vietanhdev/segment-anything-2-onnx-models/resolve/main/sam2_hiera_base_plus.zip
+  type: segment_anything
 - name: "sam2_hiera_large_20240803"
   display_name: Segment Anything 2 (Hiera-Large)
   download_url: https://huggingface.co/vietanhdev/segment-anything-2-onnx-models/resolve/main/sam2_hiera_large.zip
+  type: segment_anything
 - name: "mobile_sam_20230629"
   display_name: Segment Anything (MobileSAM)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/mobile_sam_20230629.zip
+  type: segment_anything
 - name: "sam_vit_b_01ec64"
   display_name: Segment Anything (ViT-B)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_b_01ec64.zip
+  type: segment_anything
 - name: "sam_vit_b_01ec64_quant"
   display_name: Segment Anything (ViT-B Quant)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_b_01ec64_quant.zip
+  type: segment_anything
 - name: "sam_vit_l_0b3195"
   display_name: Segment Anything (ViT-L)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_l_0b3195.zip
+  type: segment_anything
 - name: "sam_vit_l_0b3195_quant"
   display_name: Segment Anything (ViT-L Quant)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_l_0b3195_quant.zip
+  type: segment_anything
 - name: "sam_vit_h_4b8939"
   display_name: Segment Anything (ViT-H)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_h_4b8939.zip
+  type: segment_anything
 - name: "sam_vit_h_4b8939_quant"
   display_name: Segment Anything (ViT-H Quant)
   download_url: https://huggingface.co/vietanhdev/segment-anything-onnx-models/resolve/main/sam_vit_h_4b8939_quant.zip
+  type: segment_anything
 - name: "yolov8n-r20230415"
   display_name: YOLOv8n
   download_url: https://github.com/vietanhdev/anylabeling-assets/releases/download/v0.4.0/yolov8n-r20230415.zip
+  type: yolov8
 - name: "yolov8s-r20230415"
   display_name: YOLOv8s
   download_url: https://github.com/vietanhdev/anylabeling-assets/releases/download/v0.4.0/yolov8s-r20230415.zip
+  type: yolov8
 - name: "yolov8m-r20230415"
   display_name: YOLOv8m
   download_url: https://github.com/vietanhdev/anylabeling-assets/releases/download/v0.4.0/yolov8m-r20230415.zip
+  type: yolov8
 - name: "yolov8l-r20230415"
   display_name: YOLOv8l
   download_url: https://github.com/vietanhdev/anylabeling-assets/releases/download/v0.4.0/yolov8l-r20230415.zip
+  type: yolov8
 - name: "yolov8x-r20230415"
   display_name: YOLOv8x
   download_url: https://github.com/vietanhdev/anylabeling-assets/releases/download/v0.4.0/yolov8x-r20230415.zip
+  type: yolov8

anylabeling/services/auto_labeling/model_manager.py

@@ -108,14 +108,19 @@ def load_model_configs(self):
             model_config = copy.deepcopy(model)
             config_file = model.get("config_file", None)
             if config_file:
-                with open(config_file) as f:
-                    model_config = yaml.safe_load(f)
-                    model_config["config_file"] = os.path.normpath(
-                        os.path.abspath(config_file)
-                    )
-                    model_config["is_custom_model"] = model.get(
-                        "is_custom_model", False
-                    )
+                # Use utf-8-sig to strip any UTF-8 BOM that may be present in
+                # config files created on Windows (BOM in the first key would
+                # turn "type" into "\ufefftype", causing a KeyError on load).
+                with open(config_file, encoding="utf-8-sig") as f:
+                    file_config = yaml.safe_load(f)
+                # Overlay file config on top of master config so that fields
+                # present in models.yaml (e.g. "type") are never lost even if
+                # the on-disk file is missing them.
+                model_config.update(file_config)
+                model_config["config_file"] = os.path.normpath(
+                    os.path.abspath(config_file)
+                )
+                model_config["is_custom_model"] = model.get("is_custom_model", False)
             model_configs.append(model_config)
 
         # Sort by last used
@@ -181,7 +186,7 @@ def load_custom_model(self, config_file):
 
         # Check config file content
         model_config = {}
-        with open(config_file) as f:
+        with open(config_file, encoding="utf-8-sig") as f:
             model_config = yaml.safe_load(f)
             model_config["config_file"] = os.path.abspath(config_file)
         if not model_config:
@@ -353,7 +358,7 @@ def _download_and_extract_model(self, model_config):
         # Check if model is already downloaded
         if not os.path.exists(config_file):
             raise ValueError(self.tr("Error in loading config file."))
-        with open(config_file) as f:
+        with open(config_file, encoding="utf-8-sig") as f:
             model_config = yaml.safe_load(f)
         if model_config.get("has_downloaded", False):
             return
@@ -381,12 +386,13 @@ def _download_and_extract_model(self, model_config):
         # Clean up
         shutil.rmtree(tmp_dir)
 
-        # Update config file
-        with open(config_file) as f:
+        # Update config file – use utf-8-sig to strip any BOM introduced
+        # by Windows tools when the zip was created.
+        with open(config_file, encoding="utf-8-sig") as f:
             model_config = yaml.safe_load(f)
         model_config["has_downloaded"] = True
         model_config["config_file"] = config_file
-        with open(config_file, "w") as f:
+        with open(config_file, "w", encoding="utf-8") as f:
             yaml.dump(model_config, f)
 
         return model_config