digitalhub 0.8.0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

digitalhub/entities/function/spec.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.spec.base import Spec, SpecParams
+
+
+class FunctionSpec(Spec):
+    """
+    Specification for a Function.
+    """
+
+
+class FunctionParams(SpecParams):
+    """
+    Function parameters model.
+    """
+
+
+class SourceCodeStruct:
+    """
+    Source code struct.
+    """
+
+    def __init__(
+        self,
+        source: str | None = None,
+        handler: str | None = None,
+        code: str | None = None,
+        base64: str | None = None,
+        init_function: str | None = None,
+        lang: str | None = None,
+    ) -> None:
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        source : str
+            Source reference.
+        handler : str
+            Function entrypoint.
+        code : str
+            Source code (plain).
+        base64 : str
+            Source code (base64 encoded).
+        init_function : str
+            Init function for remote execution.
+        lang : str
+            Source code language (hint).
+        """
+        self.source = source
+        self.handler = handler
+        self.code = code
+        self.base64 = base64
+        self.init_function = init_function
+        self.lang = lang
+
+    def to_dict(self) -> dict:
+        """
+        Convert to dictionary.
+
+        Returns
+        -------
+        dict
+            Dictionary representation of the object.
+        """
+        dict_ = {}
+        if self.source is not None:
+            dict_["source"] = self.source
+        if self.handler is not None:
+            dict_["handler"] = self.handler
+        if self.base64 is not None:
+            dict_["base64"] = self.base64
+        if self.init_function is not None:
+            dict_["init_function"] = self.init_function
+        if self.lang is not None:
+            dict_["lang"] = self.lang
+
+        return dict_
+
+    def __repr__(self) -> str:
+        return str(self.to_dict())

digitalhub/entities/function/status.py

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

digitalhub/entities/model/builder.py

@@ -0,0 +1,152 @@
+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
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.model.entity._base 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:
+    """
+    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.
+
+    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,
+    )
+
+
+def model_from_dict(obj: dict) -> Model:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Model
+        Object instance.
+    """
+    kind = obj.get("kind")
+    cls = _choose_model_type(kind)
+    return cls.from_dict(obj)

digitalhub/entities/model/crud.py

@@ -2,20 +2,22 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.context.builder import check_context
 from digitalhub.entities._base.crud import (
-    delete_entity,
-    get_material_entity,
-    get_material_entity_versions,
-    import_context_entity,
-    list_material_entities,
-    new_context_entity,
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
 )
-from digitalhub.entities._base.entity._constructors.uuid import build_uuid
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.entities.utils.utils import build_log_path_from_source, eval_local_source
+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.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.model._base.entity import Model
+    from digitalhub.entities.model.entity._base import Model
 
 
 ENTITY_TYPE = EntityTypes.MODEL.value
@@ -28,7 +30,7 @@ def new_model(
     uuid: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    embedded: bool = False,
+    embedded: bool = True,
     path: str | None = None,
     **kwargs,
 ) -> Model:
@@ -44,7 +46,7 @@ def new_model(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object.
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
     description : str
         Description of the object (human readable).
     labels : list[str]
@@ -68,7 +70,8 @@ def new_model(
     >>>                    kind="model",
     >>>                    path="s3://my-bucket/my-key")
     """
-    return new_context_entity(
+    check_context(project)
+    obj = model_from_parameters(
         project=project,
         name=name,
         kind=kind,
@@ -79,6 +82,8 @@ def new_model(
         path=path,
         **kwargs,
     )
+    obj.save()
+    return obj
 
 
 def log_model(
@@ -166,13 +171,16 @@ def get_model(
     >>>                 project="my-project",
     >>>                 entity_id="my-model-id")
     """
-    return get_material_entity(
-        identifier=identifier,
-        entity_type=ENTITY_TYPE,
+    obj = read_entity_api_ctx(
+        identifier,
+        ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
         **kwargs,
     )
+    entity = model_from_dict(obj)
+    entity._get_files_info()
+    return entity
 
 
 def get_model_versions(
@@ -206,12 +214,18 @@ def get_model_versions(
     >>> objs = get_model_versions("my-model-name",
     >>>                           project="my-project")
     """
-    return get_material_entity_versions(
-        identifier=identifier,
+    objs = read_entity_api_ctx_versions(
+        identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         **kwargs,
     )
+    objects = []
+    for o in objs:
+        entity = model_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
 
 
 def list_models(project: str, **kwargs) -> list[Model]:
@@ -234,11 +248,17 @@ def list_models(project: str, **kwargs) -> list[Model]:
     --------
     >>> objs = list_models(project="my-project")
     """
-    return list_material_entities(
+    objs = list_entity_api_ctx(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
+    objects = []
+    for o in objs:
+        entity = model_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
 
 
 def import_model(file: str) -> Model:
@@ -259,7 +279,14 @@ def import_model(file: str) -> Model:
     --------
     >>> obj = import_model("my-model.yaml")
     """
-    return import_context_entity(file)
+    dict_obj: dict = read_yaml(file)
+    obj = model_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
 
 
 def update_model(entity: Model) -> Model:
@@ -321,7 +348,7 @@ def delete_model(
     >>>                    project="my-project",
     >>>                    delete_all_versions=True)
     """
-    return delete_entity(
+    return delete_entity_api_ctx(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

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

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

digitalhub/entities/model/entity/huggingface.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.model.entity._base import Model
+
+
+class ModelHuggingface(Model):
+    """
+    Huggingface model.
+    """

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

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

digitalhub/entities/model/entity/model.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.model.entity._base import Model
+
+
+class ModelModel(Model):
+    """
+    Model model.
+    """

digitalhub/entities/model/entity/sklearn.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.model.entity._base import Model
+
+
+class ModelSklearn(Model):
+    """
+    SKLearn model.
+    """

digitalhub/entities/model/spec.py

@@ -0,0 +1,146 @@
+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

@@ -0,0 +1,33 @@
+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.
+    """