2023-08-05 22:22:23 +00:00
|
|
|
from pathlib import Path
|
|
|
|
|
|
|
|
|
|
import pytest
|
|
|
|
|
|
feat: refactor services folder/module structure
Refactor services folder/module structure.
**Motivation**
While working on our services I've repeatedly encountered circular imports and a general lack of clarity regarding where to put things. The structure introduced goes a long way towards resolving those issues, setting us up for a clean structure going forward.
**Services**
Services are now in their own folder with a few files:
- `services/{service_name}/__init__.py`: init as needed, mostly empty now
- `services/{service_name}/{service_name}_base.py`: the base class for the service
- `services/{service_name}/{service_name}_{impl_type}.py`: the default concrete implementation of the service - typically one of `sqlite`, `default`, or `memory`
- `services/{service_name}/{service_name}_common.py`: any common items - models, exceptions, utilities, etc
Though it's a bit verbose to have the service name both as the folder name and the prefix for files, I found it is _extremely_ confusing to have all of the base classes just be named `base.py`. So, at the cost of some verbosity when importing things, I've included the service name in the filename.
There are some minor logic changes. For example, in `InvocationProcessor`, instead of assigning the model manager service to a variable to be used later in the file, the service is used directly via the `Invoker`.
**Shared**
Things that are used across disparate services are in `services/shared/`:
- `default_graphs.py`: previously in `services/`
- `graphs.py`: previously in `services/`
- `paginatation`: generic pagination models used in a few services
- `sqlite`: the `SqliteDatabase` class, other sqlite-specific things
2023-09-24 08:11:07 +00:00
|
|
|
from invokeai.app.services.config.config_default import InvokeAIAppConfig
|
2023-08-18 14:57:18 +00:00
|
|
|
from invokeai.backend import BaseModelType, ModelManager, ModelType, SubModelType
|
2023-08-05 22:22:23 +00:00
|
|
|
|
2023-08-05 22:46:46 +00:00
|
|
|
BASIC_MODEL_NAME = ("SDXL base", BaseModelType.StableDiffusionXL, ModelType.Main)
|
|
|
|
|
VAE_OVERRIDE_MODEL_NAME = ("SDXL with VAE", BaseModelType.StableDiffusionXL, ModelType.Main)
|
2023-08-09 14:52:29 +00:00
|
|
|
VAE_NULL_OVERRIDE_MODEL_NAME = ("SDXL with empty VAE", BaseModelType.StableDiffusionXL, ModelType.Main)
|
2023-08-05 22:46:46 +00:00
|
|
|
|
2023-08-05 22:22:23 +00:00
|
|
|
|
|
|
|
|
@pytest.fixture
|
|
|
|
|
def model_manager(datadir) -> ModelManager:
|
|
|
|
|
InvokeAIAppConfig.get_config(root=datadir)
|
|
|
|
|
return ModelManager(datadir / "configs" / "relative_sub.models.yaml")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def test_get_model_names(model_manager: ModelManager):
|
|
|
|
|
names = model_manager.model_names()
|
2023-08-05 22:46:46 +00:00
|
|
|
assert names[:2] == [BASIC_MODEL_NAME, VAE_OVERRIDE_MODEL_NAME]
|
2023-08-05 22:22:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
def test_get_model_path_for_diffusers(model_manager: ModelManager, datadir: Path):
|
2023-08-05 22:46:46 +00:00
|
|
|
model_config = model_manager._get_model_config(BASIC_MODEL_NAME[1], BASIC_MODEL_NAME[0], BASIC_MODEL_NAME[2])
|
2023-08-05 22:22:23 +00:00
|
|
|
top_model_path, is_override = model_manager._get_model_path(model_config)
|
|
|
|
|
expected_model_path = datadir / "models" / "sdxl" / "main" / "SDXL base 1_0"
|
|
|
|
|
assert top_model_path == expected_model_path
|
|
|
|
|
assert not is_override
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def test_get_model_path_for_overridden_vae(model_manager: ModelManager, datadir: Path):
|
2023-08-05 22:46:46 +00:00
|
|
|
model_config = model_manager._get_model_config(
|
|
|
|
|
VAE_OVERRIDE_MODEL_NAME[1], VAE_OVERRIDE_MODEL_NAME[0], VAE_OVERRIDE_MODEL_NAME[2]
|
|
|
|
|
)
|
2023-08-05 22:22:23 +00:00
|
|
|
vae_model_path, is_override = model_manager._get_model_path(model_config, SubModelType.Vae)
|
|
|
|
|
expected_vae_path = datadir / "models" / "sdxl" / "vae" / "sdxl-vae-fp16-fix"
|
|
|
|
|
assert vae_model_path == expected_vae_path
|
|
|
|
|
assert is_override
|
2023-08-09 14:52:29 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
def test_get_model_path_for_null_overridden_vae(model_manager: ModelManager, datadir: Path):
|
|
|
|
|
model_config = model_manager._get_model_config(
|
|
|
|
|
VAE_NULL_OVERRIDE_MODEL_NAME[1], VAE_NULL_OVERRIDE_MODEL_NAME[0], VAE_NULL_OVERRIDE_MODEL_NAME[2]
|
|
|
|
|
)
|
|
|
|
|
vae_model_path, is_override = model_manager._get_model_path(model_config, SubModelType.Vae)
|
|
|
|
|
assert not is_override
|
