digitalhub 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

digitalhub/entities/run/_base/entity.py

@@ -5,7 +5,8 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes, State
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._commons.metrics import MetricType, set_metrics, validate_metric_value
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.factory.api import (
     build_runtime,
     build_spec,
@@ -137,7 +138,7 @@ class Run(UnversionedEntity):
         dict
             Run logs.
         """
-        return processor.read_run_logs(self.project, self.ENTITY_TYPE, self.id)
+        return context_processor.read_run_logs(self.project, self.ENTITY_TYPE, self.id)
 
     def stop(self) -> None:
         """
@@ -148,7 +149,7 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return processor.stop_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.stop_run(self.project, self.ENTITY_TYPE, self.id)
 
     def resume(self) -> None:
         """
@@ -159,7 +160,55 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return processor.resume_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.resume_run(self.project, self.ENTITY_TYPE, self.id)
+
+    def log_metric(
+        self,
+        key: str,
+        value: MetricType,
+        overwrite: bool = False,
+        single_value: bool = False,
+    ) -> None:
+        """
+        Log metric into entity status.
+        A metric is named by a key and value (single number or list of numbers).
+        The metric by default is put in a list or appended to an existing list.
+        If single_value is True, the value will be a single number.
+
+        Parameters
+        ----------
+        key : str
+            Key of the metric.
+        value : MetricType
+            Value of the metric.
+        overwrite : bool
+            If True, overwrite existing metric.
+        single_value : bool
+            If True, value is a single value.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        Log a new value in a list
+        >>> entity.log_metric("loss", 0.002)
+
+        Append a new value in a list
+        >>> entity.log_metric("loss", 0.0019)
+
+        Log a list of values and append them to existing metric:
+        >>> entity.log_metric("loss", [0.0018, 0.0015])
+
+        Log a single value (not represented as list):
+        >>> entity.log_metric("accuracy", 0.9, single_value=True)
+
+        Log a list of values and overwrite existing metric:
+        >>> entity.log_metric("accuracy", [0.8, 0.9], overwrite=True)
+        """
+        self._set_metrics(key, value, overwrite, single_value)
+        context_processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
 
     ##############################
     #  Helpers
@@ -280,7 +329,7 @@ class Run(UnversionedEntity):
         exec_type = get_entity_type_from_kind(exec_kind)
         string_to_split = getattr(self.spec, exec_type)
         exec_name, exec_id = string_to_split.split("://")[-1].split("/")[-1].split(":")
-        return processor.read_context_entity(
+        return context_processor.read_context_entity(
             exec_name,
             entity_type=exec_type,
             project=self.project,
@@ -298,8 +347,56 @@ class Run(UnversionedEntity):
             Task from backend.
         """
         task_id = self.spec.task.split("://")[-1].split("/")[-1]
-        return processor.read_unversioned_entity(
+        return context_processor.read_unversioned_entity(
             task_id,
             entity_type=EntityTypes.TASK.value,
             project=self.project,
         ).to_dict()
+
+    def _get_metrics(self) -> None:
+        """
+        Get model metrics from backend.
+
+        Returns
+        -------
+        None
+        """
+        self.status.metrics = context_processor.read_metrics(
+            project=self.project,
+            entity_type=self.ENTITY_TYPE,
+            entity_id=self.id,
+        )
+
+    def _set_metrics(
+        self,
+        key: str,
+        value: MetricType,
+        overwrite: bool,
+        single_value: bool,
+    ) -> None:
+        """
+        Set model metrics.
+
+        Parameters
+        ----------
+        key : str
+            Key of the metric.
+        value : MetricType
+            Value of the metric.
+        overwrite : bool
+            If True, overwrite existing metric.
+        single_value : bool
+            If True, value is a single value.
+
+        Returns
+        -------
+        None
+        """
+        value = validate_metric_value(value)
+        self.status.metrics = set_metrics(
+            self.status.metrics,
+            key,
+            value,
+            overwrite,
+            single_value,
+        )

digitalhub/entities/run/_base/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 from digitalhub.entities.task._base.models import K8s
 
@@ -47,8 +49,8 @@ class RunValidator(SpecValidator, K8s):
     """
 
     # Task parameters
-    function: str = None
-    workflow: str = None
+    function: Optional[str] = None
+    workflow: Optional[str] = None
 
     # Run parameters
     task: str

digitalhub/entities/run/_base/status.py

@@ -7,3 +7,15 @@ class RunStatus(Status):
     """
     RunStatus status.
     """
+
+    def __init__(
+        self,
+        state: str,
+        message: str | None = None,
+        transitions: list[dict] | None = None,
+        k8s: dict | None = None,
+        metrics: dict | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(state, message, transitions, k8s, **kwargs)
+        self.metrics = metrics if metrics is not None else {}

digitalhub/entities/run/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
@@ -53,7 +53,7 @@ def new_run(
     >>>               kind="python+run",
     >>>               task="task-string")
     """
-    return processor.create_context_entity(
+    return context_processor.create_context_entity(
         project=project,
         kind=kind,
         uuid=uuid,
@@ -95,7 +95,7 @@ def get_run(
     >>> obj = get_run("my-run-id"
     >>>               project="my-project")
     """
-    return processor.read_unversioned_entity(
+    return context_processor.read_unversioned_entity(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -124,7 +124,7 @@ def list_runs(project: str, **kwargs) -> list[Run]:
     >>> objs = list_runs(project="my-project")
     """
     # TODO more examples: search by function, latest for task and function
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -149,7 +149,7 @@ def import_run(file: str) -> Run:
     -------
     >>> obj = import_run("my-run.yaml")
     """
-    return processor.import_context_entity(file)
+    return context_processor.import_context_entity(file)
 
 
 def load_run(file: str) -> Run:
@@ -170,7 +170,7 @@ def load_run(file: str) -> Run:
     --------
     >>> obj = load_run("my-run.yaml")
     """
-    return processor.load_context_entity(file)
+    return context_processor.load_context_entity(file)
 
 
 def update_run(entity: Run) -> Run:
@@ -191,7 +191,7 @@ def update_run(entity: Run) -> Run:
     --------
     >>> obj = update_run(obj)
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -228,7 +228,7 @@ def delete_run(
     """
     if not identifier.startswith("store://") and project is None:
         raise EntityError("Specify entity key or entity ID combined with project")
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/secret/_base/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -52,7 +52,7 @@ class Secret(VersionedEntity):
         None
         """
         obj = {self.name: value}
-        processor.update_secret_data(self.project, self.ENTITY_TYPE, obj)
+        context_processor.update_secret_data(self.project, self.ENTITY_TYPE, obj)
 
     def read_secret_value(self) -> dict:
         """
@@ -64,5 +64,5 @@ class Secret(VersionedEntity):
             Value of the secret.
         """
         params = {"keys": self.name}
-        data = processor.read_secret_data(self.project, self.ENTITY_TYPE, params=params)
+        data = context_processor.read_secret_data(self.project, self.ENTITY_TYPE, params=params)
         return data[self.name]

digitalhub/entities/secret/_base/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
@@ -28,8 +30,8 @@ class SecretValidator(SpecValidator):
     SecretValidator validator.
     """
 
-    path: str = None
+    path: Optional[str] = None
     """Path to the secret."""
 
-    provider: str = None
+    provider: Optional[str] = None
     """Provider of the secret."""

digitalhub/entities/secret/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
@@ -58,7 +58,7 @@ def new_secret(
     """
     if secret_value is None:
         raise ValueError("secret_value must be provided.")
-    obj: Secret = processor.create_context_entity(
+    obj: Secret = context_processor.create_context_entity(
         project=project,
         name=name,
         kind="secret",
@@ -108,13 +108,15 @@ def get_secret(
     >>>                  entity_id="my-secret-id")
     """
     if not identifier.startswith("store://"):
+        if project is None:
+            raise ValueError("Project must be provided.")
         secrets = list_secrets(project=project, **kwargs)
         for secret in secrets:
             if secret.name == identifier:
                 return secret
         else:
             raise EntityNotExistsError(f"Secret {identifier} not found.")
-    return processor.read_context_entity(
+    return context_processor.read_context_entity(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -154,7 +156,7 @@ def get_secret_versions(
     >>> objs = get_secret_versions("my-secret-name",
     >>>                            project="my-project")
     """
-    return processor.read_context_entity_versions(
+    return context_processor.read_context_entity_versions(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -182,7 +184,7 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     --------
     >>> objs = list_secrets(project="my-project")
     """
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -207,7 +209,7 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    return processor.import_context_entity(file)
+    return context_processor.import_context_entity(file)
 
 
 def load_secret(file: str) -> Secret:
@@ -228,7 +230,7 @@ def load_secret(file: str) -> Secret:
     --------
     >>> obj = load_secret("my-secret.yaml")
     """
-    return processor.load_context_entity(file)
+    return context_processor.load_context_entity(file)
 
 
 def update_secret(entity: Secret) -> Secret:
@@ -249,7 +251,7 @@ def update_secret(entity: Secret) -> Secret:
     --------
     >>> obj = update_secret(obj)
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -295,7 +297,7 @@ def delete_secret(
     >>>                     project="my-project",
     >>>                     delete_all_versions=True)
     """
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/task/_base/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.factory.api import build_entity_from_params, get_entity_type_from_kind, get_executable_kind
 
 if typing.TYPE_CHECKING:
@@ -107,7 +107,7 @@ class Task(UnversionedEntity):
             Run object.
         """
         if save:
-            return processor.create_context_entity(**kwargs)
+            return context_processor.create_context_entity(**kwargs)
         return build_entity_from_params(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:
@@ -124,7 +124,7 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
-        return processor.read_context_entity(entity_key)
+        return context_processor.read_context_entity(entity_key)
 
     def delete_run(self, entity_key: str) -> dict:
         """
@@ -140,4 +140,4 @@ class Task(UnversionedEntity):
         dict
             Response from backend.
         """
-        return processor.delete_context_entity(entity_key)
+        return context_processor.delete_context_entity(entity_key)

digitalhub/entities/task/_base/models.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -30,7 +31,7 @@ class Volume(BaseModel):
     mount_path: str
     """Volume mount path inside the container."""
 
-    spec: dict[str, str] = None
+    spec: Optional[dict[str, str]] = None
     """Volume spec."""
 
 
@@ -63,13 +64,13 @@ class Resource(BaseModel):
     Resource model.
     """
 
-    cpu: ResourceItem = None
+    cpu: Optional[ResourceItem] = None
     """CPU resource model."""
 
-    mem: ResourceItem = None
+    mem: Optional[ResourceItem] = None
     """Memory resource model."""
 
-    gpu: ResourceItem = None
+    gpu: Optional[ResourceItem] = None
     """GPU resource model."""
 
 
@@ -90,31 +91,31 @@ class Toleration(BaseModel):
     Toleration model.
     """
 
-    key: str = None
+    key: Optional[str] = None
     """Toleration key."""
 
-    operator: str = None
+    operator: Optional[str] = None
     """Toleration operator."""
 
-    value: str = None
+    value: Optional[str] = None
     """Toleration value."""
 
-    effect: str = None
+    effect: Optional[str] = None
     """Toleration effect."""
 
-    toleration_seconds: int = None
+    toleration_seconds: Optional[int] = None
     """Toleration seconds."""
 
 
 class V1NodeSelectorRequirement(BaseModel):
     key: str
     operator: str
-    values: list[str] = None
+    values: Optional[list[str]] = None
 
 
 class V1NodeSelectorTerm(BaseModel):
-    match_expressions: list[V1NodeSelectorRequirement] = None
-    match_fields: list[V1NodeSelectorRequirement] = None
+    match_expressions: Optional[list[V1NodeSelectorRequirement]] = None
+    match_fields: Optional[list[V1NodeSelectorRequirement]] = None
 
 
 class V1NodeSelector(BaseModel):
@@ -129,21 +130,21 @@ class V1PreferredSchedulingTerm(BaseModel):
 class V1LabelSelectorRequirement(BaseModel):
     key: str
     operator: str
-    values: list[str] = None
+    values: Optional[list[str]] = None
 
 
 class V1LabelSelector(BaseModel):
-    match_expressions: list[V1LabelSelectorRequirement] = None
-    match_labels: dict[str, str] = None
+    match_expressions: Optional[list[V1LabelSelectorRequirement]] = None
+    match_labels: Optional[dict[str, str]] = None
 
 
 class V1PodAffinityTerm(BaseModel):
-    label_selector: V1LabelSelector = None
-    match_label_keys: list[str] = None
-    mismatch_label_keys: list[str] = None
-    namespace_selector: V1LabelSelector = None
-    namespaces: list[str] = None
-    topology_key: str
+    label_selector: Optional[V1LabelSelector] = None
+    match_label_keys: Optional[list[str]] = None
+    mismatch_label_keys: Optional[list[str]] = None
+    namespace_selector: Optional[V1LabelSelector] = None
+    namespaces: Optional[list[str]] = None
+    topology_key: Optional[str] = None
 
 
 class V1WeightedPodAffinityTerm(BaseModel):
@@ -152,18 +153,18 @@ class V1WeightedPodAffinityTerm(BaseModel):
 
 
 class V1NodeAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1PreferredSchedulingTerm] = None
-    required_during_scheduling_ignored_during_execution: V1NodeSelector = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1PreferredSchedulingTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[V1NodeSelector] = None
 
 
 class V1PodAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
-    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1WeightedPodAffinityTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[list[V1PodAffinityTerm]] = None
 
 
 class V1PodAntiAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
-    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1WeightedPodAffinityTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[list[V1PodAffinityTerm]] = None
 
 
 class Affinity(BaseModel):
@@ -171,13 +172,13 @@ class Affinity(BaseModel):
     Affinity model.
     """
 
-    node_affinity: V1NodeAffinity = None
+    node_affinity: Optional[V1NodeAffinity] = None
     """Node affinity."""
 
-    pod_affinity: V1PodAffinity = None
+    pod_affinity: Optional[V1PodAffinity] = None
     """Pod affinity."""
 
-    pod_anti_affinity: V1PodAntiAffinity = None
+    pod_anti_affinity: Optional[V1PodAntiAffinity] = None
     """Pod anti affinity."""
 
 
@@ -186,34 +187,34 @@ class K8s(BaseModel):
     Kubernetes resource model.
     """
 
-    node_selector: list[NodeSelector] = None
+    node_selector: Optional[list[NodeSelector]] = None
     """Node selector."""
 
-    volumes: list[Volume] = None
+    volumes: Optional[list[Volume]] = None
     """List of volumes."""
 
-    resources: Resource = None
+    resources: Optional[Resource] = None
     """Resources restrictions."""
 
-    affinity: Affinity = None
+    affinity: Optional[Affinity] = None
     """Affinity."""
 
-    tolerations: list[Toleration] = None
+    tolerations: Optional[list[Toleration]] = None
     """Tolerations."""
 
-    envs: list[Env] = None
+    envs: Optional[list[Env]] = None
     """Env variables."""
 
-    secrets: list[str] = None
+    secrets: Optional[list[str]] = None
     """List of secret names."""
 
-    profile: str = None
+    profile: Optional[str] = None
     """Profile template."""
 
-    runtime_class: str = None
+    runtime_class: Optional[str] = None
     """Runtime class name."""
 
-    priority_class: str = None
+    priority_class: Optional[str] = None
     """Priority class."""
 
 
@@ -235,3 +236,13 @@ class CoreServiceType(Enum):
     CLUSTER_IP = "ClusterIP"
     NODE_PORT = "NodePort"
     LOAD_BALANCER = "LoadBalancer"
+
+
+class CorePullPolicy(Enum):
+    """
+    CorePullPolicy enum.
+    """
+
+    ALWAYS = "Always"
+    IF_NOT_PRESENT = "IfNotPresent"
+    NEVER = "Never"

digitalhub/entities/task/_base/spec.py

@@ -66,6 +66,8 @@ class TaskSpecWorkflow(TaskSpec):
         self.envs = envs
         self.secrets = secrets
         self.profile = profile
+        self.runtime_class = runtime_class
+        self.priority_class = priority_class
 
 
 class TaskValidator(SpecValidator):

digitalhub/entities/task/_base/utils.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 
-def build_task_actions(kind_action_list: list[tuple[str, str]]) -> dict[str, str]:
+def build_task_actions(kind_action_list: list[tuple[str, str]]) -> list[dict[str, str]]:
     """
     Build task actions.
 
@@ -12,7 +12,7 @@ def build_task_actions(kind_action_list: list[tuple[str, str]]) -> dict[str, str
 
     Returns
     -------
-    dict[str, str]
+    list[dict[str, str]]
         Returns the task actions.
     """
     return [{"kind": kind, "action": action} for (kind, action) in kind_action_list]