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

digitalhub/entities/function/models.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+from pathlib import Path
+
+from pydantic import BaseModel
+
+from digitalhub.utils.exceptions import EntityError
+from digitalhub.utils.generic_utils import decode_string
+from digitalhub.utils.uri_utils import map_uri_scheme
+
+
+class SourceCodeStruct:
+    """
+    Source code struct.
+    """
+
+    def __init__(
+        self,
+        source: str | None = None,
+        code: str | None = None,
+        base64: str | None = None,
+        handler: str | None = None,
+        lang: str | None = None,
+    ) -> None:
+        self.source = source
+        self.code = code
+        self.base64 = base64
+        self.handler = handler
+        self.lang = lang
+
+    @staticmethod
+    @abstractmethod
+    def source_check(source: dict) -> dict:
+        """
+        Check source.
+
+        Parameters
+        ----------
+        source : dict
+            Source.
+
+        Returns
+        -------
+        dict
+            Checked source.
+        """
+
+    def show_source_code(self) -> str:
+        """
+        Show source code.
+
+        Returns
+        -------
+        str
+            Source code.
+        """
+        if self.code is not None:
+            return self.code
+        if self.base64 is not None:
+            try:
+                return decode_string(self.base64)
+            except Exception:
+                raise EntityError("Something got wrong during source code decoding.")
+        if (self.source is not None) and (map_uri_scheme(self.source) == "local"):
+            try:
+                return Path(self.source).read_text()
+            except Exception:
+                raise EntityError("Cannot access source code.")
+        return ""
+
+    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.base64 is not None:
+            dict_["base64"] = self.base64
+        if self.handler is not None:
+            dict_["handler"] = self.handler
+        if self.lang is not None:
+            dict_["lang"] = self.lang
+
+        return dict_
+
+    def __repr__(self) -> str:
+        return str(self.to_dict())
+
+
+class SourceCodeParams(BaseModel):
+    """
+    Source code params.
+    """
+
+    source: dict = None
+    "Source code details as dictionary"
+
+    code_src: str = None
+    "Pointer to source code"
+
+    handler: str = None
+    "Function entrypoint"
+
+    code: str = None
+    "Source code (plain text)"
+
+    base64: str = None
+    "Source code (base64 encoded)"
+
+    lang: str = None
+    "Source code language (hint)"

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

@@ -0,0 +1,358 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import check_context
+from digitalhub.entities._base.crud import (
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    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.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.model.entity._base import Model
+
+
+ENTITY_TYPE = EntityTypes.MODEL.value
+
+
+def new_model(
+    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).
+    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.
+
+    Examples
+    --------
+    >>> obj = new_model(project="my-project",
+    >>>                    name="my-model",
+    >>>                    kind="model",
+    >>>                    path="s3://my-bucket/my-key")
+    """
+    check_context(project)
+    obj = model_from_parameters(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        path=path,
+        **kwargs,
+    )
+    obj.save()
+    return obj
+
+
+def log_model(
+    project: str,
+    name: str,
+    kind: str,
+    source: list[str] | str,
+    path: str | None = None,
+    **kwargs,
+) -> Model:
+    """
+    Create and upload an object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    source : str
+        Model location on local path.
+    path : str
+        Destination path of the model. If not provided, it's generated.
+    **kwargs : dict
+        New model spec parameters.
+
+    Returns
+    -------
+    Model
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = log_model(project="my-project",
+    >>>                 name="my-model",
+    >>>                 kind="model",
+    >>>                 source="./local-path")
+    """
+    eval_local_source(source)
+
+    if path is None:
+        uuid = build_uuid()
+        kwargs["uuid"] = uuid
+        path = build_log_path_from_source(project, ENTITY_TYPE, name, uuid, source)
+
+    obj = new_model(project=project, name=name, kind=kind, path=path, **kwargs)
+    obj.upload(source)
+    return obj
+
+
+def get_model(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> Model:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    Model
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_model("store://my-model-key")
+
+    Using entity name:
+    >>> obj = get_model("my-model-name"
+    >>>                 project="my-project",
+    >>>                 entity_id="my-model-id")
+    """
+    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(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> list[Model]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Model]
+        List of object instances.
+
+    Examples
+    --------
+    Using entity key:
+    >>> objs = get_model_versions("store://my-model-key")
+
+    Using entity name:
+    >>> objs = get_model_versions("my-model-name",
+    >>>                           project="my-project")
+    """
+    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]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Model]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_models(project="my-project")
+    """
+    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:
+    """
+    Import object from a YAML file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Model
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = import_model("my-model.yaml")
+    """
+    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:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Model
+        Object to update.
+
+    Returns
+    -------
+    Model
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = get_model("store://my-model-key")
+    """
+    return entity.save(update=True)
+
+
+def delete_model(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    delete_all_versions: bool = False,
+    **kwargs,
+) -> dict:
+    """
+    Delete object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    delete_all_versions : bool
+        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+
+    Examples
+    --------
+    If delete_all_versions is False:
+    >>> obj = delete_model("store://my-model-key")
+
+    Otherwise:
+    >>> obj = delete_model("my-model-name",
+    >>>                    project="my-project",
+    >>>                    delete_all_versions=True)
+    """
+    return delete_entity_api_ctx(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )