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

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 = False,
+        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/_base/entity.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities.utils.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
+
+
+class Model(MaterialEntity):
+    """
+    A class representing a model.
+    """
+
+    ENTITY_TYPE = EntityTypes.MODEL.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ModelSpec,
+        status: ModelStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+        self.spec: ModelSpec
+        self.status: ModelStatus

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/crud.py

@@ -0,0 +1,331 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.crud import (
+    delete_entity,
+    get_material_entity,
+    get_material_entity_versions,
+    import_context_entity,
+    list_material_entities,
+    new_context_entity,
+)
+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
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.model._base.entity 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 = False,
+    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.
+
+    Examples
+    --------
+    >>> obj = new_model(project="my-project",
+    >>>                    name="my-model",
+    >>>                    kind="model",
+    >>>                    path="s3://my-bucket/my-key")
+    """
+    return new_context_entity(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        path=path,
+        **kwargs,
+    )
+
+
+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")
+    """
+    return get_material_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+
+
+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")
+    """
+    return get_material_entity_versions(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+
+
+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")
+    """
+    return list_material_entities(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+
+
+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")
+    """
+    return import_context_entity(file)
+
+
+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(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )

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

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/models.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+
+class Signature(BaseModel):
+    """
+    MLFlow model signature.
+    """
+
+    inputs: str = None
+    outputs: str = None
+    params: str = None
+
+
+class Dataset(BaseModel):
+    """
+    MLFlow model dataset.
+    """
+
+    name: str = None
+    digest: str = None
+    profile: str = None
+    schema_: str = Field(default=None, alias="schema")
+    source: str = None
+    source_type: str = None