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

digitalhub/entities/model/huggingface/spec.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator
+
+
+class ModelSpecHuggingface(ModelSpec):
+    """
+    ModelSpecHuggingface 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 ModelValidatorHuggingface(ModelValidator):
+    """
+    ModelValidatorHuggingface validator.
+    """
+
+    model_id: str = None
+    """Huggingface model id. If not specified, the model is loaded from the model path."""
+
+    model_revision: str = None
+    """Huggingface model revision."""

digitalhub/entities/model/huggingface/status.py

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

digitalhub/entities/model/mlflow/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.builder import ModelBuilder
+from digitalhub.entities.model.mlflow.entity import ModelMlflow
+from digitalhub.entities.model.mlflow.spec import ModelSpecMlflow, ModelValidatorMlflow
+from digitalhub.entities.model.mlflow.status import ModelStatusMlflow
+
+
+class ModelModelBuilder(ModelBuilder):
+    """
+    ModelMlflow builder.
+    """
+
+    ENTITY_CLASS = ModelMlflow
+    ENTITY_SPEC_CLASS = ModelSpecMlflow
+    ENTITY_SPEC_VALIDATOR = ModelValidatorMlflow
+    ENTITY_STATUS_CLASS = ModelStatusMlflow
+    ENTITY_KIND = "mlflow"

digitalhub/entities/model/mlflow/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.mlflow.spec import ModelSpecMlflow
+    from digitalhub.entities.model.mlflow.status import ModelStatusMlflow
+
+
+class ModelMlflow(Model):
+    """
+    ModelMlflow class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ModelSpecMlflow,
+        status: ModelStatusMlflow,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ModelSpecMlflow
+        self.status: ModelStatusMlflow

digitalhub/entities/model/mlflow/spec.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator
+from digitalhub.entities.model.mlflow.models import Dataset, Signature
+
+
+class ModelSpecMlflow(ModelSpec):
+    """
+    ModelSpecMlflow 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 ModelValidatorMlflow(ModelValidator):
+    """
+    ModelValidatorMlflow validator.
+    """
+
+    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."""

digitalhub/entities/model/mlflow/status.py

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

digitalhub/entities/model/{entity/mlflow.py → mlflow/utils.py}

@@ -1,17 +1,8 @@
-from __future__ import annotations
-
 from urllib.parse import urlparse
 
 import mlflow
 
-from digitalhub.entities.model.entity._base import Model
-from digitalhub.entities.model.models import Dataset, Signature
-
-
-class ModelMlflow(Model):
-    """
-    Mlflow model.
-    """
+from digitalhub.entities.model.mlflow.models import Dataset, Signature
 
 
 def from_mlflow_run(run_id: str) -> dict:

digitalhub/entities/model/model/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.builder import ModelBuilder
+from digitalhub.entities.model.model.entity import ModelModel
+from digitalhub.entities.model.model.spec import ModelSpecModel, ModelValidatorModel
+from digitalhub.entities.model.model.status import ModelStatusModel
+
+
+class ModelMlflowBuilder(ModelBuilder):
+    """
+    ModelModel builder.
+    """
+
+    ENTITY_CLASS = ModelModel
+    ENTITY_SPEC_CLASS = ModelSpecModel
+    ENTITY_SPEC_VALIDATOR = ModelValidatorModel
+    ENTITY_STATUS_CLASS = ModelStatusModel
+    ENTITY_KIND = "model"

digitalhub/entities/model/model/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.model.spec import ModelSpecModel
+    from digitalhub.entities.model.model.status import ModelStatusModel
+
+
+class ModelModel(Model):
+    """
+    ModelModel class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ModelSpecModel,
+        status: ModelStatusModel,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ModelSpecModel
+        self.status: ModelStatusModel

digitalhub/entities/model/model/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator
+
+
+class ModelSpecModel(ModelSpec):
+    """
+    ModelSpecModel specifications.
+    """
+
+
+class ModelValidatorModel(ModelValidator):
+    """
+    ModelValidatorModel validator.
+    """

digitalhub/entities/model/model/status.py

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

digitalhub/entities/model/sklearn/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.builder import ModelBuilder
+from digitalhub.entities.model.sklearn.entity import ModelSklearn
+from digitalhub.entities.model.sklearn.spec import ModelSpecSklearn, ModelValidatorSklearn
+from digitalhub.entities.model.sklearn.status import ModelStatusSklearn
+
+
+class ModelSklearnBuilder(ModelBuilder):
+    """
+    ModelSklearn builder.
+    """
+
+    ENTITY_CLASS = ModelSklearn
+    ENTITY_SPEC_CLASS = ModelSpecSklearn
+    ENTITY_SPEC_VALIDATOR = ModelValidatorSklearn
+    ENTITY_STATUS_CLASS = ModelStatusSklearn
+    ENTITY_KIND = "sklearn"

digitalhub/entities/model/sklearn/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.sklearn.spec import ModelSpecSklearn
+    from digitalhub.entities.model.sklearn.status import ModelStatusSklearn
+
+
+class ModelSklearn(Model):
+    """
+    ModelSklearn class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ModelSpecSklearn,
+        status: ModelStatusSklearn,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ModelSpecSklearn
+        self.status: ModelStatusSklearn

digitalhub/entities/model/sklearn/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator
+
+
+class ModelSpecSklearn(ModelSpec):
+    """
+    ModelSpecSklearn specifications.
+    """
+
+
+class ModelValidatorSklearn(ModelValidator):
+    """
+    ModelValidatorSklearn validator.
+    """

digitalhub/entities/model/sklearn/status.py

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

digitalhub/entities/project/_base/builder.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from digitalhub.entities._builders.entity import EntityBuilder
+from digitalhub.entities.project._base.entity import Project
+from digitalhub.entities.project._base.spec import ProjectSpec, ProjectValidator
+from digitalhub.entities.project._base.status import ProjectStatus
+from digitalhub.entities.utils.entity_types import EntityTypes
+
+
+class ProjectProjectBuilder(EntityBuilder):
+    """
+    ProjectProject builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.PROJECT.value
+    ENTITY_CLASS = Project
+    ENTITY_SPEC_CLASS = ProjectSpec
+    ENTITY_SPEC_VALIDATOR = ProjectValidator
+    ENTITY_STATUS_CLASS = ProjectStatus
+    ENTITY_KIND = "project"
+
+    def build(
+        self,
+        name: str,
+        kind: str,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        local: bool = False,
+        context: str | None = None,
+        **kwargs,
+    ) -> Project:
+        """
+        Create a new object.
+
+        Parameters
+        ----------
+        name : str
+            Object name.
+        kind : str
+            Kind the object.
+        description : str
+            Description of the object (human readable).
+        labels : list[str]
+            List of labels.
+        local : bool
+            If True, use local backend, if False use DHCore backend. Default to False.
+        context : str
+            The context local folder of the project.
+        **kwargs : dict
+            Spec keyword arguments.
+
+        Returns
+        -------
+        Project
+            Object instance.
+        """
+        name = self.build_name(name)
+        metadata = self.build_metadata(
+            project=name,
+            name=name,
+            description=description,
+            labels=labels,
+        )
+        spec = self.build_spec(
+            context=context,
+            **kwargs,
+        )
+        status = self.build_status()
+        return self.build_entity(
+            name=name,
+            kind=kind,
+            metadata=metadata,
+            spec=spec,
+            status=status,
+            local=local,
+        )
+
+    def from_dict(self, obj: dict, validate: bool = True) -> Project:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments must be validated.
+
+        Returns
+        -------
+        Project
+            Object instance.
+        """
+        parsed_dict = self._parse_dict(obj, validate=validate)
+        return self.build_entity(**parsed_dict)
+
+    def _parse_dict(self, obj: dict, validate: bool = True) -> dict:
+        """
+        Get dictionary and parse it to a valid entity dictionary.
+
+        Parameters
+        ----------
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        name = self.build_name(obj.get("name"))
+        kind = obj.get("kind")
+        local = obj.get("local", False)
+        metadata = self.build_metadata(**obj.get("metadata", {}))
+        spec = self.build_spec(validate=validate, **obj.get("spec", {}))
+        status = self.build_status(**obj.get("status", {}))
+        user = obj.get("user")
+        return {
+            "name": name,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+            "local": local,
+        }

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

@@ -12,11 +12,7 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     update_entity_api_base,
 )
-from digitalhub.entities._base.entity.base import Entity
-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._base.entity.entity import Entity
 from digitalhub.entities.artifact.crud import (
     artifact_from_dict,
     delete_artifact,
@@ -39,7 +35,6 @@ from digitalhub.entities.dataitem.crud import (
     new_dataitem,
     update_dataitem,
 )
-from digitalhub.entities.entity_types import EntityTypes
 from digitalhub.entities.function.crud import (
     delete_function,
     function_from_dict,
@@ -71,6 +66,7 @@ from digitalhub.entities.secret.crud import (
     new_secret,
     update_secret,
 )
+from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.workflow.crud import (
     delete_workflow,
     get_workflow,
@@ -87,16 +83,16 @@ from digitalhub.utils.io_utils import write_yaml
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities.artifact.entity._base import Artifact
-    from digitalhub.entities.dataitem.entity._base import Dataitem
-    from digitalhub.entities.function.entity import Function
-    from digitalhub.entities.model.entity._base import Model
-    from digitalhub.entities.project.spec import ProjectSpec
-    from digitalhub.entities.project.status import ProjectStatus
-    from digitalhub.entities.run.entity import Run
-    from digitalhub.entities.secret.entity import Secret
-    from digitalhub.entities.workflow.entity import Workflow
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.artifact._base.entity import Artifact
+    from digitalhub.entities.dataitem._base.entity import Dataitem
+    from digitalhub.entities.function._base.entity import Function
+    from digitalhub.entities.model._base.entity import Model
+    from digitalhub.entities.project._base.spec import ProjectSpec
+    from digitalhub.entities.project._base.status import ProjectStatus
+    from digitalhub.entities.run._base.entity import Run
+    from digitalhub.entities.secret._base.entity import Secret
+    from digitalhub.entities.workflow._base.entity import Workflow
 
 
 ARTIFACTS = EntityTypes.ARTIFACT.value + "s"
@@ -308,44 +304,6 @@ class Project(Entity):
                     except EntityAlreadyExistsError:
                         pass
 
-    ##############################
-    #  Static interface methods
-    ##############################
-
-    @staticmethod
-    def _parse_dict(obj: dict, validate: bool = True) -> dict:
-        """
-        Get dictionary and parse it to a valid entity dictionary.
-
-        Parameters
-        ----------
-        entity : str
-            Entity type.
-        obj : dict
-            Dictionary to parse.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the attributes of the entity instance.
-        """
-        name = build_name(obj.get("name"))
-        kind = obj.get("kind")
-        metadata = build_metadata(kind, **obj.get("metadata", {}))
-        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
-        status = build_status(kind, **obj.get("status", {}))
-        user = obj.get("user")
-        local = obj.get("local", False)
-        return {
-            "name": name,
-            "kind": kind,
-            "metadata": metadata,
-            "spec": spec,
-            "status": status,
-            "user": user,
-            "local": local,
-        }
-
     ##############################
     #  Artifacts
     ##############################
@@ -371,7 +329,7 @@ class Project(Entity):
         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]
@@ -662,7 +620,7 @@ class Project(Entity):
         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]
@@ -966,7 +924,7 @@ class Project(Entity):
         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]
@@ -1257,7 +1215,7 @@ class Project(Entity):
         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]
@@ -1503,7 +1461,7 @@ class Project(Entity):
         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]
@@ -1747,7 +1705,7 @@ class Project(Entity):
         name : str
             Object name.
         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/project/{spec.py → _base/spec.py}

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.spec.base import Spec, SpecParams
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
 class ProjectSpec(Spec):
     """
-    Project specification.
+    ProjectSpec specifications.
     """
 
     def __init__(
@@ -26,9 +26,9 @@ class ProjectSpec(Spec):
         self.models = models if models is not None else []
 
 
-class ProjectParams(SpecParams):
+class ProjectValidator(SpecValidator):
     """
-    Parameters model for project.
+    ProjectValidator validator.
     """
 
     context: str = None

digitalhub/entities/project/_base/status.py

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