wehub-resource-sync
cddb07a176
docs / deploy (push) Has been cancelled
docs / changes (push) Has been cancelled
docs / check-and-build (push) Has been cancelled
build container image / cpu (push) Has been cancelled
build container image / cuda (push) Has been cancelled
build container image / rocm (push) Has been cancelled
frontend checks / frontend-checks (push) Has been cancelled
frontend tests / frontend-tests (push) Has been cancelled
lfs checks / lfs-check (push) Has been cancelled
python checks / python-checks (push) Has been cancelled
python tests / py3.12: macos-default (push) Has been cancelled
python tests / py3.11: windows-cpu (push) Has been cancelled
python tests / py3.12: windows-cpu (push) Has been cancelled
python tests / py3.11: linux-cpu (push) Has been cancelled
typegen checks / typegen-checks (push) Has been cancelled
uv lock checks / uv-lock-checks (push) Has been cancelled
openapi checks / openapi-checks (push) Has been cancelled
python tests / py3.11: macos-default (push) Has been cancelled
python tests / py3.12: linux-cpu (push) Has been cancelled
69 lines
2.2 KiB
Python
69 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 HuggingFaceMetadataFetch
|
|
|
|
data = HuggingFaceMetadataFetch().from_id("<REPO_ID>")
|
|
assert isinstance(data, HuggingFaceMetadata)
|
|
"""
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import Optional
|
|
|
|
from pydantic.networks import AnyHttpUrl
|
|
from requests.sessions import Session
|
|
|
|
from invokeai.backend.model_manager.metadata.metadata_base import (
|
|
AnyModelRepoMetadata,
|
|
AnyModelRepoMetadataValidator,
|
|
BaseMetadata,
|
|
)
|
|
from invokeai.backend.model_manager.taxonomy import ModelRepoVariant
|
|
|
|
|
|
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: BaseMetadata = AnyModelRepoMetadataValidator.validate_json(json) # type: ignore
|
|
return metadata
|