mirror of
https://github.com/invoke-ai/InvokeAI.git
synced 2026-02-10 16:55:06 -05:00
102 lines
3.2 KiB
Python
102 lines
3.2 KiB
Python
# Copyright (c) 2023 Lincoln D. Stein and the InvokeAI Team
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import Optional
|
|
|
|
import torch
|
|
from typing_extensions import Self
|
|
|
|
from invokeai.app.services.invoker import Invoker
|
|
from invokeai.app.services.shared.invocation_context import InvocationContextData
|
|
from invokeai.backend.model_manager.config import AnyModelConfig, BaseModelType, ModelType, SubModelType
|
|
from invokeai.backend.model_manager.load.load_base import LoadedModel
|
|
|
|
from ..config import InvokeAIAppConfig
|
|
from ..download import DownloadQueueServiceBase
|
|
from ..events.events_base import EventServiceBase
|
|
from ..model_install import ModelInstallServiceBase
|
|
from ..model_load import ModelLoadServiceBase
|
|
from ..model_records import ModelRecordServiceBase
|
|
|
|
|
|
class ModelManagerServiceBase(ABC):
|
|
"""Abstract base class for the model manager service."""
|
|
|
|
# attributes:
|
|
# store: ModelRecordServiceBase = Field(description="An instance of the model record configuration service.")
|
|
# install: ModelInstallServiceBase = Field(description="An instance of the model install service.")
|
|
# load: ModelLoadServiceBase = Field(description="An instance of the model load service.")
|
|
|
|
@classmethod
|
|
@abstractmethod
|
|
def build_model_manager(
|
|
cls,
|
|
app_config: InvokeAIAppConfig,
|
|
model_record_service: ModelRecordServiceBase,
|
|
download_queue: DownloadQueueServiceBase,
|
|
events: EventServiceBase,
|
|
execution_device: torch.device,
|
|
) -> Self:
|
|
"""
|
|
Construct the model manager service instance.
|
|
|
|
Use it rather than the __init__ constructor. This class
|
|
method simplifies the construction considerably.
|
|
"""
|
|
pass
|
|
|
|
@property
|
|
@abstractmethod
|
|
def store(self) -> ModelRecordServiceBase:
|
|
"""Return the ModelRecordServiceBase used to store and retrieve configuration records."""
|
|
pass
|
|
|
|
@property
|
|
@abstractmethod
|
|
def load(self) -> ModelLoadServiceBase:
|
|
"""Return the ModelLoadServiceBase used to load models from their configuration records."""
|
|
pass
|
|
|
|
@property
|
|
@abstractmethod
|
|
def install(self) -> ModelInstallServiceBase:
|
|
"""Return the ModelInstallServiceBase used to download and manipulate model files."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def start(self, invoker: Invoker) -> None:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def stop(self, invoker: Invoker) -> None:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def load_model_by_config(
|
|
self,
|
|
model_config: AnyModelConfig,
|
|
submodel_type: Optional[SubModelType] = None,
|
|
context_data: Optional[InvocationContextData] = None,
|
|
) -> LoadedModel:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def load_model_by_key(
|
|
self,
|
|
key: str,
|
|
submodel_type: Optional[SubModelType] = None,
|
|
context_data: Optional[InvocationContextData] = None,
|
|
) -> LoadedModel:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def load_model_by_attr(
|
|
self,
|
|
model_name: str,
|
|
base_model: BaseModelType,
|
|
model_type: ModelType,
|
|
submodel: Optional[SubModelType] = None,
|
|
context_data: Optional[InvocationContextData] = None,
|
|
) -> LoadedModel:
|
|
pass
|