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

digitalhub/entities/function/_base/builder.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.versioned.builder import VersionedBuilder
+from digitalhub.entities.utils.entity_types import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.function._base.entity import Function
+
+
+class FunctionBuilder(VersionedBuilder):
+    """
+    Function builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.FUNCTION.value
+
+    def build(
+        self,
+        kind: str,
+        project: str,
+        name: str,
+        uuid: str | None = None,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        embedded: bool = True,
+        **kwargs,
+    ) -> Function:
+        """
+        Create a new object.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        name : str
+            Object name.
+        kind : str
+            Kind the object.
+        uuid : str
+            ID of the object.
+        description : str
+            Description of the object (human readable).
+        labels : list[str]
+            List of labels.
+        embedded : bool
+            Flag to determine if object spec must be embedded in project spec.
+        **kwargs : dict
+            Spec keyword arguments.
+
+        Returns
+        -------
+        Function
+            Object instance.
+        """
+        name = self.build_name(name)
+        uuid = self.build_uuid(uuid)
+        metadata = self.build_metadata(
+            project=project,
+            name=name,
+            description=description,
+            labels=labels,
+            embedded=embedded,
+        )
+        spec = self.build_spec(
+            **kwargs,
+        )
+        status = self.build_status()
+        return self.build_entity(
+            project=project,
+            name=name,
+            uuid=uuid,
+            kind=kind,
+            metadata=metadata,
+            spec=spec,
+            status=status,
+        )

digitalhub/entities/function/{entity.py → _base/entity.py}

@@ -3,16 +3,16 @@ from __future__ import annotations
 import typing
 from concurrent.futures import ThreadPoolExecutor
 
-from digitalhub.entities._base.entity.executable import ExecutableEntity
-from digitalhub.entities.entity_types import EntityTypes
-from digitalhub.runtimes.builder import get_kind_registry
+from digitalhub.entities._base.executable.entity import ExecutableEntity
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.runtimes.utils import get_kind_registry
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities.function.spec import FunctionSpec
-    from digitalhub.entities.function.status import FunctionStatus
-    from digitalhub.entities.run.entity import Run
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.function._base.spec import FunctionSpec
+    from digitalhub.entities.function._base.status import FunctionStatus
+    from digitalhub.entities.run._base.entity import Run
 
 
 class Function(ExecutableEntity):
@@ -72,7 +72,7 @@ class Function(ExecutableEntity):
             Run instance.
         """
         # Get kind registry
-        kind_reg = get_kind_registry(self.kind)
+        kind_reg = get_kind_registry(self.kind, self.project)
 
         # Get task and run kind
         task_kind = kind_reg.get_task_kind_from_action(action=action)

digitalhub/entities/function/{models.py → _base/models.py}

@@ -94,7 +94,7 @@ class SourceCodeStruct:
         return str(self.to_dict())
 
 
-class SourceCodeParams(BaseModel):
+class SourceCodeValidator(BaseModel):
     """
     Source code params.
     """

digitalhub/entities/function/_base/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+
+
+class FunctionSpec(Spec):
+    """
+    FunctionSpec specifications.
+    """
+
+
+class FunctionValidator(SpecValidator):
+    """
+    FunctionValidator validator.
+    """

digitalhub/entities/function/_base/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.status import Status
+
+
+class FunctionStatus(Status):
+    """
+    FunctionStatus status.
+    """

digitalhub/entities/function/builder.py

@@ -1,72 +1,33 @@
 from __future__ import annotations
 
-from digitalhub.entities._builders.metadata import build_metadata
-from digitalhub.entities._builders.name import build_name
-from digitalhub.entities._builders.spec import build_spec
-from digitalhub.entities._builders.status import build_status
-from digitalhub.entities._builders.uuid import build_uuid
-from digitalhub.entities.function.entity import Function
+import typing
 
+from digitalhub.factory.factory import factory
+from digitalhub.utils.exceptions import BuilderError
 
-def function_from_parameters(
-    project: str,
-    name: str,
-    kind: str,
-    uuid: str | None = None,
-    description: str | None = None,
-    labels: list[str] | None = None,
-    embedded: bool = True,
-    **kwargs,
-) -> Function:
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.function._base.entity import Function
+
+
+def function_from_parameters(**kwargs) -> Function:
     """
-    Create a new Function instance and persist it to the backend.
+    Create a new object.
 
     Parameters
     ----------
-    project : str
-        Project name.
-    name : str
-        Object name.
-    kind : str
-        Kind the object.
-    uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
-    description : str
-        Description of the object (human readable).
-    labels : list[str]
-        List of labels.
-    embedded : bool
-        Flag to determine if object spec must be embedded in project spec.
-    **kwargs : dict
-        Spec keyword arguments.
+    **kwargs
+        Keyword arguments.
 
     Returns
     -------
     Function
         Object instance.
     """
-    name = build_name(name)
-    uuid = build_uuid(uuid)
-    spec = build_spec(kind, **kwargs)
-    metadata = build_metadata(
-        kind,
-        project=project,
-        name=name,
-        version=uuid,
-        description=description,
-        labels=labels,
-        embedded=embedded,
-    )
-    status = build_status(kind)
-    return Function(
-        project=project,
-        name=name,
-        uuid=uuid,
-        kind=kind,
-        metadata=metadata,
-        spec=spec,
-        status=status,
-    )
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_params(kind, **kwargs)
 
 
 def function_from_dict(obj: dict) -> Function:
@@ -81,6 +42,10 @@ def function_from_dict(obj: dict) -> Function:
     Returns
     -------
     Function
-        Function object.
+        Object instance.
     """
-    return Function.from_dict(obj)
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_dict(kind, obj)

digitalhub/entities/function/crud.py

@@ -9,13 +9,13 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     read_entity_api_ctx_versions,
 )
-from digitalhub.entities.entity_types import EntityTypes
 from digitalhub.entities.function.builder import function_from_dict, function_from_parameters
+from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.utils.exceptions import EntityAlreadyExistsError
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.function.entity import Function
+    from digitalhub.entities.function._base.entity import Function
 
 ENTITY_TYPE = EntityTypes.FUNCTION.value
 
@@ -42,7 +42,7 @@ def new_function(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+        ID of the object.
     description : str
         Description of the object (human readable).
     labels : list[str]

digitalhub/entities/model/_base/builder.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.versioned.builder import VersionedBuilder
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.model._base.entity import Model
+
+
+class ModelBuilder(VersionedBuilder):
+    """
+    Model builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.MODEL.value
+
+    def build(
+        self,
+        kind: str,
+        project: str,
+        name: str,
+        uuid: str | None = None,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        embedded: bool = True,
+        path: str | None = None,
+        **kwargs,
+    ) -> Model:
+        """
+        Create a new object.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        name : str
+            Object name.
+        kind : str
+            Kind the object.
+        uuid : str
+            ID of the object.
+        description : str
+            Description of the object (human readable).
+        labels : list[str]
+            List of labels.
+        embedded : bool
+            Flag to determine if object spec must be embedded in project spec.
+        path : str
+            Object path on local file system or remote storage. It is also the destination path of upload() method.
+        **kwargs : dict
+            Spec keyword arguments.
+
+        Returns
+        -------
+        Model
+            Object instance.
+        """
+        if path is None:
+            raise EntityError("Path must be provided.")
+
+        name = self.build_name(name)
+        uuid = self.build_uuid(uuid)
+        metadata = self.build_metadata(
+            project=project,
+            name=name,
+            description=description,
+            labels=labels,
+            embedded=embedded,
+        )
+        spec = self.build_spec(
+            path=path,
+            **kwargs,
+        )
+        status = self.build_status()
+        return self.build_entity(
+            project=project,
+            name=name,
+            uuid=uuid,
+            kind=kind,
+            metadata=metadata,
+            spec=spec,
+            status=status,
+        )

digitalhub/entities/model/{entity/_base.py → _base/entity.py}

@@ -2,13 +2,13 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.entity.material import MaterialEntity
-from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities.utils.entity_types import EntityTypes
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities.model.spec import ModelSpec
-    from digitalhub.entities.model.status import ModelStatus
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.model._base.spec import ModelSpec
+    from digitalhub.entities.model._base.status import ModelStatus
 
 
 class Model(MaterialEntity):

digitalhub/entities/model/_base/spec.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.spec import MaterialSpec, MaterialValidator
+
+
+class ModelSpec(MaterialSpec):
+    """
+    ModelSpec 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 ModelValidator(MaterialValidator):
+    """
+    ModelValidator validator.
+    """
+
+    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 validator."""
+
+    metrics: dict = None
+    """Model metrics."""

digitalhub/entities/model/_base/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.status import MaterialStatus
+
+
+class ModelStatus(MaterialStatus):
+    """
+    ModelStatus status.
+    """

digitalhub/entities/model/builder.py

@@ -2,135 +2,32 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._builders.metadata import build_metadata
-from digitalhub.entities._builders.name import build_name
-from digitalhub.entities._builders.spec import build_spec
-from digitalhub.entities._builders.status import build_status
-from digitalhub.entities._builders.uuid import build_uuid
-from digitalhub.utils.exceptions import EntityError
+from digitalhub.factory.factory import factory
+from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.model.entity._base import Model
+    from digitalhub.entities.model._base.entity import Model
 
-# Manage class mapper
-cls_mapper = {}
 
-try:
-    from digitalhub.entities.model.entity.model import ModelModel
-
-    cls_mapper["model"] = ModelModel
-except ImportError:
-    ...
-
-try:
-    from digitalhub.entities.model.entity.mlflow import ModelMlflow
-
-    cls_mapper["mlflow"] = ModelMlflow
-except ImportError:
-    ...
-try:
-    from digitalhub.entities.model.entity.sklearn import ModelSklearn
-
-    cls_mapper["sklearn"] = ModelSklearn
-except ImportError:
-    ...
-try:
-    from digitalhub.entities.model.entity.huggingface import ModelHuggingface
-
-    cls_mapper["huggingface"] = ModelHuggingface
-except ImportError:
-    pass
-
-
-def _choose_model_type(kind: str) -> type[Model]:
-    """
-    Choose class based on kind.
-
-    Parameters
-    ----------
-    kind : str
-        Kind the object.
-
-    Returns
-    -------
-    type[Model]
-        Class of the model.
-    """
-    try:
-        return cls_mapper[kind]
-    except KeyError:
-        raise EntityError(f"Unknown model kind: {kind}")
-
-
-def model_from_parameters(
-    project: str,
-    name: str,
-    kind: str,
-    uuid: str | None = None,
-    description: str | None = None,
-    labels: list[str] | None = None,
-    embedded: bool = True,
-    path: str | None = None,
-    **kwargs,
-) -> Model:
+def model_from_parameters(**kwargs) -> Model:
     """
     Create a new object.
 
     Parameters
     ----------
-    project : str
-        Project name.
-    name : str
-        Object name.
-    kind : str
-        Kind the object.
-    uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
-    labels : list[str]
-        List of labels.
-    description : str
-        Description of the object (human readable).
-    embedded : bool
-        Flag to determine if object spec must be embedded in project spec.
-    path : str
-        Object path on local file system or remote storage. It is also the destination path of upload() method.
-    **kwargs : dict
-        Spec keyword arguments.
+    **kwargs
+        Keyword arguments.
 
     Returns
     -------
     Model
         Object instance.
     """
-    if path is None:
-        raise EntityError("Path must be provided.")
-    name = build_name(name)
-    uuid = build_uuid(uuid)
-    metadata = build_metadata(
-        kind,
-        project=project,
-        name=name,
-        version=uuid,
-        description=description,
-        labels=labels,
-        embedded=embedded,
-    )
-    spec = build_spec(
-        kind,
-        path=path,
-        **kwargs,
-    )
-    status = build_status(kind)
-    cls = _choose_model_type(kind)
-    return cls(
-        project=project,
-        name=name,
-        uuid=uuid,
-        kind=kind,
-        metadata=metadata,
-        spec=spec,
-        status=status,
-    )
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_params(kind, **kwargs)
 
 
 def model_from_dict(obj: dict) -> Model:
@@ -147,6 +44,8 @@ def model_from_dict(obj: dict) -> Model:
     Model
         Object instance.
     """
-    kind = obj.get("kind")
-    cls = _choose_model_type(kind)
-    return cls.from_dict(obj)
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_dict(kind, obj)

digitalhub/entities/model/crud.py

@@ -10,14 +10,14 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx_versions,
 )
 from digitalhub.entities._builders.uuid import build_uuid
-from digitalhub.entities.entity_types import EntityTypes
 from digitalhub.entities.model.builder import model_from_dict, model_from_parameters
-from digitalhub.entities.utils import build_log_path_from_source, eval_local_source
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.utils.utils import build_log_path_from_source, eval_local_source
 from digitalhub.utils.exceptions import EntityAlreadyExistsError
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.model.entity._base import Model
+    from digitalhub.entities.model._base.entity import Model
 
 
 ENTITY_TYPE = EntityTypes.MODEL.value
@@ -46,7 +46,7 @@ def new_model(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+        ID of the object.
     description : str
         Description of the object (human readable).
     labels : list[str]

digitalhub/entities/model/huggingface/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.builder import ModelBuilder
+from digitalhub.entities.model.huggingface.entity import ModelHuggingface
+from digitalhub.entities.model.huggingface.spec import ModelSpecHuggingface, ModelValidatorHuggingface
+from digitalhub.entities.model.huggingface.status import ModelStatusHuggingface
+
+
+class ModelHuggingfaceBuilder(ModelBuilder):
+    """
+    ModelHuggingface builder.
+    """
+
+    ENTITY_CLASS = ModelHuggingface
+    ENTITY_SPEC_CLASS = ModelSpecHuggingface
+    ENTITY_SPEC_VALIDATOR = ModelValidatorHuggingface
+    ENTITY_STATUS_CLASS = ModelStatusHuggingface
+    ENTITY_KIND = "huggingface"

digitalhub/entities/model/huggingface/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.model._base.entity import Model
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.model.huggingface.spec import ModelSpecHuggingface
+    from digitalhub.entities.model.huggingface.status import ModelStatusHuggingface
+
+
+class ModelHuggingface(Model):
+    """
+    ModelHuggingface class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ModelSpecHuggingface,
+        status: ModelStatusHuggingface,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ModelSpecHuggingface
+        self.status: ModelStatusHuggingface