mirror of
https://github.com/invoke-ai/InvokeAI.git
synced 2026-04-23 03:00:31 -04:00
5745ce9c7d
- Cache stat collection enabled. - Implemented ONNX loading. - Add ability to specify the repo version variant in installer CLI. - If caller asks for a repo version that doesn't exist, will fall back to empty version rather than raising an error.
67 lines
2.2 KiB
Python
67 lines
2.2 KiB
Python
# Copyright (c) 2023 Lincoln D. Stein and the InvokeAI Development Team
|
|
|
|
"""
|
|
This module is the base class for subclasses that fetch metadata from model repositories
|
|
|
|
Usage:
|
|
|
|
from invokeai.backend.model_manager.metadata.fetch import CivitAIMetadataFetch
|
|
|
|
fetcher = CivitaiMetadataFetch()
|
|
metadata = fetcher.from_url("https://civitai.com/models/206883/split")
|
|
print(metadata.trained_words)
|
|
"""
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import Optional
|
|
|
|
from pydantic.networks import AnyHttpUrl
|
|
from requests.sessions import Session
|
|
|
|
from invokeai.backend.model_manager import ModelRepoVariant
|
|
|
|
from ..metadata_base import AnyModelRepoMetadata, AnyModelRepoMetadataValidator
|
|
|
|
|
|
class ModelMetadataFetchBase(ABC):
|
|
"""Fetch metadata from remote generative model repositories."""
|
|
|
|
@abstractmethod
|
|
def __init__(self, session: Optional[Session] = None):
|
|
"""
|
|
Initialize the fetcher with an optional requests.sessions.Session object.
|
|
|
|
By providing a configurable Session object, we can support unit tests on
|
|
this module without an internet connection.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def from_url(self, url: AnyHttpUrl) -> AnyModelRepoMetadata:
|
|
"""
|
|
Given a URL to a model repository, return a ModelMetadata object.
|
|
|
|
This method will raise a `UnknownMetadataException`
|
|
in the event that the requested model metadata is not found at the provided location.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def from_id(self, id: str, variant: Optional[ModelRepoVariant] = None) -> AnyModelRepoMetadata:
|
|
"""
|
|
Given an ID for a model, return a ModelMetadata object.
|
|
|
|
:param id: An ID.
|
|
:param variant: A model variant from the ModelRepoVariant enum.
|
|
|
|
This method will raise a `UnknownMetadataException`
|
|
in the event that the requested model's metadata is not found at the provided id.
|
|
"""
|
|
pass
|
|
|
|
@classmethod
|
|
def from_json(cls, json: str) -> AnyModelRepoMetadata:
|
|
"""Given the JSON representation of the metadata, return the corresponding Pydantic object."""
|
|
metadata = AnyModelRepoMetadataValidator.validate_json(json)
|
|
return metadata
|