digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

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/mlflow/utils.py

@@ -0,0 +1,81 @@
+from urllib.parse import urlparse
+
+import mlflow
+
+from digitalhub.entities.model.mlflow.models import Dataset, Signature
+
+
+def from_mlflow_run(run_id: str) -> dict:
+    """
+    Extract from mlflow run spec for Digitalhub Model.
+
+    Parameters
+    ----------
+    run_id : str
+        The id of the mlflow run.
+
+    Returns
+    -------
+    dict
+        The extracted spec.
+    """
+
+    # Get MLFlow run
+    client = mlflow.MlflowClient()
+    run = client.get_run(run_id)
+
+    # Extract spec
+    data = run.data
+    parameters = data.params
+    metrics = data.metrics
+    source_path = urlparse(run.info.artifact_uri).path
+    model_uri = f"runs:/{run_id}/model"
+    model = mlflow.pyfunc.load_model(model_uri=model_uri)
+    model_config = model.model_config
+    flavor = None
+    for f in model.metadata.flavors:
+        if f != "python_function":
+            flavor = f
+            break
+
+    # Extract signature
+    mlflow_signature = model.metadata.signature
+    signature = Signature(
+        inputs=mlflow_signature.inputs.to_json() if mlflow_signature.inputs else None,
+        outputs=mlflow_signature.outputs.to_json() if mlflow_signature.outputs else None,
+        params=mlflow_signature.params.to_json() if mlflow_signature.params else None,
+    ).dict()
+
+    # Extract datasets
+    datasets = []
+    if run.inputs and run.inputs.dataset_inputs:
+        datasets = [
+            Dataset(
+                name=d.dataset.name,
+                digest=d.dataset.digest,
+                profile=d.dataset.profile,
+                schema=d.dataset.schema,
+                source=d.dataset.source,
+                source_type=d.dataset.source_type,
+            ).dict()
+            for d in run.inputs.dataset_inputs
+        ]
+
+    # Create model params
+    model_params = {}
+
+    # source path
+    model_params["source"] = source_path
+
+    # common properties
+    model_params["framework"] = flavor
+    model_params["parameters"] = parameters
+    model_params["metrics"] = metrics
+
+    # specific to MLFlow
+    model_params["flavor"] = flavor
+    model_params["model_config"] = model_config
+    model_params["input_datasets"] = datasets
+    model_params["signature"] = signature
+
+    return model_params

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._base.entity.builder 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,
+        }