Merge remote-tracking branch 'origin/main' into refactor/model_manager_instantiate

# Conflicts:
#	invokeai/backend/model_management/model_manager.py

invokeai/backend/model_management/model_manager.py

@@ -426,7 +426,7 @@ class ModelManager(object):
         return (model_name, base_model, model_type)
 
     def _get_model_cache_path(self, model_path):
-        return self.app_config.models_path / ".cache" / hashlib.md5(str(model_path).encode()).hexdigest()
+        return self.resolve_model_path(Path(".cache") / hashlib.md5(str(model_path).encode()).hexdigest())
 
     @classmethod
     def initialize_model_config(cls, config_path: Path):
@@ -520,7 +520,7 @@ class ModelManager(object):
                 model_path = getattr(model_config, submodel_type)
                 is_submodel_override = True
 
-        model_path = self.app_config.root_path / model_path
+        model_path = self.resolve_model_path(model_path)
         return model_path, is_submodel_override
 
     def _get_model_config(self, base_model, model_name, model_type) -> ModelConfigBase:
@@ -618,7 +618,7 @@ class ModelManager(object):
 
             # expose paths as absolute to help web UI
             if path := model_dict.get("path"):
-                model_dict["path"] = str(self.app_config.root_path / path)
+                model_dict["path"] = str(self.resolve_model_path(path))
             models.append(model_dict)
 
         return models
@@ -655,7 +655,7 @@ class ModelManager(object):
             self.cache.uncache_model(cache_id)
 
         # if model inside invoke models folder - delete files
-        model_path = self.app_config.root_path / model_cfg.path
+        model_path = self.resolve_model_path(model_cfg.path)
         cache_path = self._get_model_cache_path(model_path)
         if cache_path.exists():
             rmtree(str(cache_path))
@@ -686,10 +686,9 @@ class ModelManager(object):
         The returned dict has the same format as the dict returned by
         model_info().
         """
-        # relativize paths as they go in - this makes it easier to move the root directory around
+        # relativize paths as they go in - this makes it easier to move the models directory around
         if path := model_attributes.get("path"):
-            if Path(path).is_relative_to(self.app_config.root_path):
-                model_attributes["path"] = str(Path(path).relative_to(self.app_config.root_path))
+            model_attributes["path"] = str(self.relative_model_path(Path(path)))
 
         model_class = self._get_implementation(base_model, model_type)
         model_config = model_class.create_config(**model_attributes)
@@ -747,7 +746,7 @@ class ModelManager(object):
         if not model_cfg:
             raise ModelNotFoundException(f"Unknown model: {model_key}")
 
-        old_path = self.app_config.root_path / model_cfg.path
+        old_path = self.resolve_model_path(model_cfg.path)
         new_name = new_name or model_name
         new_base = new_base or base_model
         new_key = self.create_key(new_name, new_base, model_type)
@@ -756,15 +755,15 @@ class ModelManager(object):
 
         # if this is a model file/directory that we manage ourselves, we need to move it
         if old_path.is_relative_to(self.app_config.models_path):
-            new_path = (
-                self.app_config.root_path
-                / "models"
-                / BaseModelType(new_base).value
-                / ModelType(model_type).value
-                / new_name
+            new_path = self.resolve_model_path(
+                Path(
+                    BaseModelType(new_base).value,
+                    ModelType(model_type).value,
+                    new_name,
+                )
             )
             move(old_path, new_path)
-            model_cfg.path = str(new_path.relative_to(self.app_config.root_path))
+            model_cfg.path = str(new_path.relative_to(self.app_config.models_path))
 
         # clean up caches
         old_model_cache = self._get_model_cache_path(old_path)
@@ -814,7 +813,7 @@ class ModelManager(object):
             **submodel,
         )
         checkpoint_path = self.app_config.root_path / info["path"]
-        old_diffusers_path = self.app_config.models_path / model.location
+        old_diffusers_path = self.resolve_model_path(model.location)
         new_diffusers_path = (
             dest_directory or self.app_config.models_path / base_model.value / model_type.value
         ) / model_name
@@ -827,7 +826,7 @@ class ModelManager(object):
             info["path"] = (
                 str(new_diffusers_path)
                 if dest_directory
-                else str(new_diffusers_path.relative_to(self.app_config.root_path))
+                else str(new_diffusers_path.relative_to(self.app_config.models_path))
             )
             info.pop("config")
 
@@ -842,6 +841,15 @@ class ModelManager(object):
 
         return result
 
+    def resolve_model_path(self, path: Union[Path, str]) -> Path:
+        """return relative paths based on configured models_path"""
+        return self.app_config.models_path / path
+
+    def relative_model_path(self, model_path: Path) -> Path:
+        if model_path.is_relative_to(self.app_config.models_path):
+            model_path = model_path.relative_to(self.app_config.models_path)
+        return model_path
+
     def search_models(self, search_folder):
         self.logger.info(f"Finding Models In: {search_folder}")
         models_folder_ckpt = Path(search_folder).glob("**/*.ckpt")
@@ -915,10 +923,17 @@ class ModelManager(object):
         new_models_found = False
 
         self.logger.info(f"Scanning {self.app_config.models_path} for new models")
-        with Chdir(self.app_config.root_path):
+        with Chdir(self.app_config.models_path):
             for model_key, model_config in list(self.models.items()):
                 model_name, cur_base_model, cur_model_type = self.parse_key(model_key)
-                model_path = self.app_config.root_path.absolute() / model_config.path
+
+                # Patch for relative path bug in older models.yaml - paths should not
+                # be starting with a hard-coded 'models'. This will also fix up
+                # models.yaml when committed.
+                if model_config.path.startswith("models"):
+                    model_config.path = str(Path(*Path(model_config.path).parts[1:]))
+
+                model_path = self.resolve_model_path(model_config.path).absolute()
                 if not model_path.exists():
                     model_class = self._get_implementation(cur_base_model, cur_model_type)
                     if model_class.save_to_config:
@@ -937,7 +952,7 @@ class ModelManager(object):
                     if model_type is not None and cur_model_type != model_type:
                         continue
                     model_class = self._get_implementation(cur_base_model, cur_model_type)
-                    models_dir = self.app_config.models_path / cur_base_model.value / cur_model_type.value
+                    models_dir = self.resolve_model_path(Path(cur_base_model.value, cur_model_type.value))
 
                     if not models_dir.exists():
                         continue  # TODO: or create all folders?
@@ -951,9 +966,7 @@ class ModelManager(object):
                                 if model_key in self.models:
                                     raise DuplicateModelException(f"Model with key {model_key} added twice")
 
-                                if model_path.is_relative_to(self.app_config.root_path):
-                                    model_path = model_path.relative_to(self.app_config.root_path)
-
+                                model_path = self.relative_model_path(model_path)
                                 model_config: ModelConfigBase = model_class.probe_config(str(model_path))
                                 self.models[model_key] = model_config
                                 new_models_found = True
@@ -964,12 +977,11 @@ class ModelManager(object):
                             except NotImplementedError as e:
                                 self.logger.warning(e)
 
-        imported_models = self.autoimport()
-
+        imported_models = self.scan_autoimport_directory()
         if (new_models_found or imported_models) and self.config_path:
             self.commit()
 
-    def autoimport(self) -> Dict[str, AddModelResult]:
+    def scan_autoimport_directory(self) -> Dict[str, AddModelResult]:
         """
         Scan the autoimport directory (if defined) and import new models, delete defunct models.
         """
@@ -1003,7 +1015,7 @@ class ModelManager(object):
         # LS: hacky
         # Patch in the SD VAE from core so that it is available for use by the UI
         try:
-            self.heuristic_import({config.root_path / "models/core/convert/sd-vae-ft-mse"})
+            self.heuristic_import({self.resolve_model_path("core/convert/sd-vae-ft-mse")})
         except:
             pass