digitalhub 0.8.0b2__py3-none-any.whl → 0.8.0b4__py3-none-any.whl

digitalhub/entities/model/spec.py

@@ -1,146 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.spec.material import MaterialParams, MaterialSpec
-from digitalhub.entities.model.models import Dataset, Signature
-
-
-class ModelSpec(MaterialSpec):
-    """
-    Model specifications.
-    """
-
-    def __init__(
-        self,
-        path: str,
-        framework: str | None = None,
-        algorithm: str | None = None,
-        base_model: str | None = None,
-        parameters: dict | None = None,
-        metrics: dict | None = None,
-    ) -> None:
-        self.path = path
-        self.framework = framework
-        self.algorithm = algorithm
-        self.base_model = base_model
-        self.parameters = parameters
-        self.metrics = metrics
-
-
-class ModelParams(MaterialParams):
-    """
-    Model parameters.
-    """
-
-    path: str
-    """Path to the model."""
-
-    framework: str = None
-    """Model framework (e.g. 'pytorch')."""
-
-    algorithm: str = None
-    """Model algorithm (e.g. 'resnet')."""
-
-    base_model: str = None
-    """Base model."""
-
-    parameters: dict = None
-    """Model parameters."""
-
-    metrics: dict = None
-    """Model metrics."""
-
-
-class ModelSpecModel(ModelSpec):
-    """
-    Model specifications.
-    """
-
-
-class ModelParamsModel(ModelParams):
-    """
-    Model parameters.
-    """
-
-
-class ModelSpecMlflow(ModelSpec):
-    """
-    Mlflow model specifications.
-    """
-
-    def __init__(
-        self,
-        path: str,
-        framework: str | None = None,
-        algorithm: str | None = None,
-        base_model: str | None = None,
-        parameters: dict | None = None,
-        metrics: dict | None = None,
-        flavor: str | None = None,
-        model_config: dict | None = None,
-        input_datasets: list[Dataset] | None = None,
-        signature: Signature = None,
-    ) -> None:
-        super().__init__(path, framework, algorithm, base_model, parameters, metrics)
-        self.flavor = flavor
-        self.model_config = model_config
-        self.input_datasets = input_datasets
-        self.signature = signature
-
-
-class ModelParamsMlflow(ModelParams):
-    """
-    Mlflow model parameters.
-    """
-
-    flavor: str = None
-    """Mlflow model flavor."""
-    model_config: dict = None
-    """Mlflow model config."""
-    input_datasets: list[Dataset] = None
-    """Mlflow input datasets."""
-    signature: Signature = None
-    """Mlflow model signature."""
-
-
-class ModelSpecSklearn(ModelSpec):
-    """
-    SKLearn model specifications.
-    """
-
-
-class ModelParamsSklearn(ModelParams):
-    """
-    SKLearn model parameters.
-    """
-
-
-class ModelSpecHuggingface(ModelSpec):
-    """
-    Huggingface model specifications.
-    """
-
-    def __init__(
-        self,
-        path: str,
-        framework: str | None = None,
-        algorithm: str | None = None,
-        base_model: str | None = None,
-        parameters: dict | None = None,
-        metrics: dict | None = None,
-        model_id: str | None = None,
-        model_revision: str = None,
-    ) -> None:
-        super().__init__(path, framework, algorithm, base_model, parameters, metrics)
-        self.model_id = model_id
-        self.model_revision = model_revision
-
-
-class ModelParamsHuggingface(ModelParams):
-    """
-    Huggingface model parameters.
-    """
-
-    model_id: str = None
-    """Huggingface model id. Optional. If not specified, the model is loaded from the model path"""
-    model_revision: str = None
-    """Huggingface model revision. Optional."""

digitalhub/entities/model/status.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.status.material import MaterialStatus
-
-
-class ModelStatus(MaterialStatus):
-    """
-    Status class for model entities.
-    """
-
-
-class ModelStatusModel(ModelStatus):
-    """
-    Status class for model entities.
-    """
-
-
-class ModelStatusMlflow(ModelStatus):
-    """
-    Status class for model entities.
-    """
-
-
-class ModelStatusSklearn(ModelStatus):
-    """
-    Status class for model entities.
-    """
-
-
-class ModelStatusHuggingface(ModelStatus):
-    """
-    Status class for model entities.
-    """

digitalhub/entities/project/status.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.status.base import Status
-
-
-class ProjectStatus(Status):
-    """
-    Status class for project entities.
-    """

digitalhub/entities/registries.py

@@ -1,48 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities.entity_types import EntityTypes
-from digitalhub.registry.registry import registry
-from digitalhub.registry.utils import create_info
-
-# Root module
-root = "digitalhub.entities"
-
-# Projects
-entity_type = EntityTypes.PROJECT.value
-prefix = entity_type.capitalize()
-project_info = create_info(root, entity_type, prefix)
-registry.register("project", project_info)
-
-
-# Secrets
-entity_type = EntityTypes.SECRET.value
-prefix = entity_type.capitalize()
-secret_info = create_info(root, entity_type, prefix)
-registry.register("secret", secret_info)
-
-
-# Artifacts
-entity_type = EntityTypes.ARTIFACT.value
-for i in ["artifact"]:
-    prefix = entity_type.capitalize()
-    suffix = i.capitalize()
-    artifact_info = create_info(root, entity_type, prefix, suffix)
-    registry.register(i, artifact_info)
-
-
-# Dataitems
-entity_type = EntityTypes.DATAITEM.value
-for i in ["dataitem", "table"]:
-    prefix = entity_type.capitalize()
-    suffix = i.capitalize()
-    dataitem_info = create_info(root, entity_type, prefix, suffix)
-    registry.register(i, dataitem_info)
-
-
-# Models
-entity_type = EntityTypes.MODEL.value
-for i in ["model", "mlflow", "sklearn", "huggingface"]:
-    prefix = entity_type.capitalize()
-    suffix = i.capitalize()
-    model_info = create_info(root, entity_type, prefix, suffix)
-    registry.register(i, model_info)

digitalhub/entities/secret/status.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.status.base import Status
-
-
-class SecretStatus(Status):
-    """
-    Status class for secret entities.
-    """

digitalhub/entities/task/status.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.status.base import Status
-
-
-class TaskStatus(Status):
-    """
-    Status class for task entities.
-    """

digitalhub/entities/workflow/spec.py

@@ -1,15 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.spec.base import Spec, SpecParams
-
-
-class WorkflowSpec(Spec):
-    """
-    Workflow specifications.
-    """
-
-
-class WorkflowParams(SpecParams):
-    """
-    Workflow parameters.
-    """

digitalhub/entities/workflow/status.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.entities._base.status.base import Status
-
-
-class WorkflowStatus(Status):
-    """
-    Status class for workflow entities.
-    """

digitalhub/registry/models.py

@@ -1,87 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-
-class RuntimeEntry(BaseModel):
-    """
-    Model for Runtime entry.
-    It specifies the module path and the runtime class name.
-    """
-
-    module: str
-    """Module path."""
-
-    class_name: str
-    """Class name."""
-
-    kind_registry_module: str
-    """Kind registry module path."""
-
-    kind_registry_class_name: str
-    """Kind registry class name."""
-
-
-class SpecEntry(BaseModel):
-    """
-    Model for Spec entry.
-    It specifies the module path, the spec class name
-    and the spec pydantic class validator.
-    """
-
-    module: str
-    """Module path."""
-
-    class_name: str
-    """Class name."""
-
-    parameters_validator: str
-    """Class name of the parameter validator."""
-
-
-class StatusEntry(BaseModel):
-    """
-    Model for Status entry.
-    It specifies the module path and the status class name.
-    """
-
-    module: str
-    """Module path."""
-
-    class_name: str
-    """Class name."""
-
-
-class MetadataEntry(BaseModel):
-    """
-    Model for Metadata entry.
-    It specifies the module path and the metadata class name.
-    """
-
-    module: str
-    """Module path."""
-
-    class_name: str
-    """Class name."""
-
-
-class RegistryEntry(BaseModel):
-    """
-    Basic entry model for every entity.
-    Functions, tasks and runs specify also the runtime field.
-    """
-
-    entity_type: str
-    """Entity type."""
-
-    spec: SpecEntry
-    """Spec infos."""
-
-    status: StatusEntry
-    """Status infos."""
-
-    metadata: MetadataEntry
-    """Metadata infos."""
-
-    runtime: RuntimeEntry = None
-    """Runtime infos."""

digitalhub/registry/registry.py

@@ -1,74 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.registry.models import RegistryEntry
-
-
-class GlobalEntityRegistry:
-    """
-    Global entity registry where all entities classpaths are stored.
-    It keeps track of all entities that are registered in the system.
-    """
-
-    def register(self, entity_kind: str, entry: dict) -> None:
-        """
-        Register an entity kind.
-
-        Parameters
-        ----------
-        entity_kind : str
-            Entity kind to be registered.
-        entry : dict
-            Entry to be registered.
-
-        Returns
-        -------
-        None
-
-        """
-        if hasattr(self, entity_kind):
-            raise ValueError(f"Entity kind {entity_kind} already registered")
-        entry = RegistryEntry(**entry)
-        setattr(self, entity_kind, entry)
-
-    def update(self, entity_kind: str, entry: dict) -> None:
-        """
-        Update an entity kind.
-
-        Parameters
-        ----------
-        entity_kind : str
-            Entity kind to be updated.
-        entry : dict
-            Entry to be updated.
-
-        Returns
-        -------
-        None
-        """
-        if hasattr(self, entity_kind):
-            entry = RegistryEntry(**entry)
-            setattr(self, entity_kind, entry)
-        else:
-            raise ValueError(f"Entity kind {entity_kind} not registered")
-
-    def get_entity_type(self, entity_kind: str) -> str:
-        """
-        Get entity type from kind.
-
-        Parameters
-        ----------
-        entity_kind : str
-            Entity kind.
-
-        Returns
-        -------
-        str
-            Entity type.
-        """
-        if not hasattr(self, entity_kind):
-            raise ValueError(f"Entity kind {entity_kind} not registered")
-        entry: RegistryEntry = getattr(self, entity_kind)
-        return entry.entity_type
-
-
-registry = GlobalEntityRegistry()

digitalhub/registry/utils.py

@@ -1,150 +0,0 @@
-from __future__ import annotations
-
-import importlib
-import importlib.metadata
-import pkgutil
-import re
-from types import ModuleType
-
-
-def import_module(package: str) -> ModuleType:
-    """
-    Import modules from package name.
-
-    Parameters
-    ----------
-    package : str
-        Package name.
-
-    Returns
-    -------
-    ModuleType
-        Module.
-    """
-    try:
-        return importlib.import_module(package)
-    except ModuleNotFoundError:
-        raise ModuleNotFoundError(f"Package {package} not found.")
-    except Exception as e:
-        raise e
-
-
-def import_class(module_to_import: str, class_name: str) -> type:
-    """
-    Import class from implemented module.
-
-    Parameters
-    ----------
-    module_to_import : str
-        Module name.
-    class_name : str
-        Class name.
-
-    Returns
-    -------
-    type
-        Class.
-    """
-    module = import_module(module_to_import)
-    try:
-        return getattr(module, class_name)
-    except AttributeError:
-        raise ModuleNotFoundError(f"Module {module_to_import} has no '{class_name}' class.")
-
-
-def list_runtimes() -> list[str]:
-    """
-    List installed runtimes for digitalhub.
-
-    Returns
-    -------
-    list
-        List of installed runtimes names.
-    """
-    pattern = r"digitalhub_runtime_.*"
-    runtimes = []
-    try:
-        for _, name, _ in pkgutil.iter_modules():
-            if re.match(pattern, name):
-                runtimes.append(name)
-        return runtimes
-    except Exception:
-        raise RuntimeError("Error listing installed runtimes.")
-
-
-def register_runtimes_entities() -> None:
-    """
-    Register runtimes and related entities into registry.
-
-    Returns
-    -------
-    None
-    """
-    for package in list_runtimes():
-        import_module(package)
-
-
-def register_entities() -> None:
-    """
-    Register layer and related entities into registry.
-
-    Returns
-    -------
-    None
-    """
-    # Try ot import registry from entities.registries module
-    try:
-        import_module("digitalhub.entities.registries")
-    except Exception:
-        pass
-
-
-def create_info(
-    root: str,
-    entity_type: str,
-    prefix: str,
-    suffix: str | None = "",
-    runtime_info: dict | None = None,
-) -> dict:
-    """
-    Create entity info.
-
-    Parameters
-    ----------
-    root : str
-        Root module.
-    entity_type : str
-        Entity type.
-    prefix : str
-        Entity prefix.
-    suffix : str
-        Entity suffix.
-    runtime_info : dict
-        Runtime info.
-
-    Returns
-    -------
-    dict
-        Entity info.
-    """
-    dict_ = {
-        "entity_type": entity_type,
-        "spec": {
-            "module": f"{root}.{entity_type}.spec",
-            "class_name": f"{prefix}Spec{suffix}",
-            "parameters_validator": f"{prefix}Params{suffix}",
-        },
-        "status": {
-            "module": f"{root}.{entity_type}.status",
-            "class_name": f"{prefix}Status{suffix}",
-        },
-        "metadata": {
-            "module": "digitalhub.entities._base.metadata",
-            "class_name": "Metadata",
-        },
-    }
-    # Add runtime only if provided
-    # (in functions, tasks, runs and workflows)
-    if runtime_info is not None:
-        dict_["runtime"] = runtime_info
-    return dict_