Skip to content

feat(mm): support customizable cache key for load_model_from_path() #7987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −5
Draft

feat(mm): support customizable cache key for load_model_from_path() #7987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion invokeai/app/services/model_load/model_load_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ def ram_cache(self) -> ModelCache:

@abstractmethod
def load_model_from_path(
self, model_path: Path, loader: Optional[Callable[[Path], AnyModel]] = None
self,
model_path: Path,
loader: Optional[Callable[[Path], AnyModel]] = None,
cache_key_extra: Optional[str] = None,
) -> LoadedModelWithoutConfig:
"""
Load the model file or directory located at the indicated Path.
Expand All @@ -46,6 +49,8 @@ def load_model_from_path(
Args:
model_path: A pathlib.Path to a checkpoint-style models file
loader: A Callable that expects a Path and returns a Dict[str, Tensor]
cache_key_extra: A string to append to the cache key. This is useful for
differentiating an instances of the same model with different parameters.

Returns:
A LoadedModel object.
Expand Down
7 changes: 5 additions & 2 deletions invokeai/app/services/model_load/model_load_default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,12 @@ def load_model(self, model_config: AnyModelConfig, submodel_type: Optional[SubMo
return loaded_model

def load_model_from_path(
self, model_path: Path, loader: Optional[Callable[[Path], AnyModel]] = None
self,
model_path: Path,
loader: Optional[Callable[[Path], AnyModel]] = None,
cache_key_extra: Optional[str] = None,
) -> LoadedModelWithoutConfig:
cache_key = str(model_path)
cache_key = f"{model_path}:{cache_key_extra}" if cache_key_extra else str(model_path)
try:
return LoadedModelWithoutConfig(cache_record=self._ram_cache.get(key=cache_key), cache=self._ram_cache)
except IndexError:
Expand Down
18 changes: 16 additions & 2 deletions invokeai/app/services/shared/invocation_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,7 @@ def load_local_model(
self,
model_path: Path,
loader: Optional[Callable[[Path], AnyModel]] = None,
cache_key_extra: Optional[str] = None,
) -> LoadedModelWithoutConfig:
"""
Load the model file located at the indicated path
Expand All @@ -509,18 +510,25 @@ def load_local_model(
Args:
path: A model Path
loader: A Callable that expects a Path and returns a dict[str|int, Any]
cache_key_extra: A string to append to the cache key. This is useful for
differentiating an instances of the same model with different parameters.

Returns:
A LoadedModelWithoutConfig object.
"""

self._util.signal_progress(f"Loading model {model_path.name}")
return self._services.model_manager.load.load_model_from_path(model_path=model_path, loader=loader)
return self._services.model_manager.load.load_model_from_path(
model_path=model_path,
loader=loader,
cache_key_extra=cache_key_extra,
)

def load_remote_model(
self,
source: str | AnyHttpUrl,
loader: Optional[Callable[[Path], AnyModel]] = None,
cache_key_extra: Optional[str] = None,
) -> LoadedModelWithoutConfig:
"""
Download, cache, and load the model file located at the indicated URL or repo_id.
Expand All @@ -535,14 +543,20 @@ def load_remote_model(
Args:
source: A URL or huggingface repoid.
loader: A Callable that expects a Path and returns a dict[str|int, Any]
cache_key_extra: A string to append to the cache key. This is useful for
differentiating an instances of the same model with different parameters.

Returns:
A LoadedModelWithoutConfig object.
"""
model_path = self._services.model_manager.install.download_and_cache_model(source=str(source))

self._util.signal_progress(f"Loading model {source}")
return self._services.model_manager.load.load_model_from_path(model_path=model_path, loader=loader)
return self._services.model_manager.load.load_model_from_path(
model_path=model_path,
loader=loader,
cache_key_extra=cache_key_extra,
)

def get_absolute_path(self, config_or_path: AnyModelConfig | Path | str) -> Path:
"""Gets the absolute path for a given model config or path.
Expand Down
Loading