digitalhub 0.13.0b3__py3-none-any.whl → 0.14.0b0__py3-none-any.whl

digitalhub/entities/model/crud.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._processors.context import context_processor
-from digitalhub.entities.artifact.utils import eval_source, process_kwargs
+from digitalhub.entities.model.utils import eval_source, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
@@ -237,14 +237,25 @@ def list_models(project: str, **kwargs) -> list[Model]:
     )
 
 
-def import_model(file: str) -> Model:
+def import_model(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Model:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -255,7 +266,12 @@ def import_model(file: str) -> Model:
     --------
     >>> obj = import_model("my-model.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_model(file: str) -> Model:

digitalhub/entities/model/utils.py

@@ -6,25 +6,32 @@ from __future__ import annotations
 
 from typing import Any
 
-from digitalhub.entities._base.entity._constructors.uuid import build_uuid
 from digitalhub.entities._base.material.utils import build_log_path_from_source, eval_local_source
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._constructors.uuid import build_uuid
 
 
 def eval_source(
     source: str | list[str] | None = None,
 ) -> Any:
     """
-    Evaluate if source is local.
+    Evaluate whether the source is local or remote.
+
+    Determines if the provided source(s) reference local files or
+    remote resources. This evaluation affects how the model
+    will be processed and stored.
 
     Parameters
     ----------
-    source : str | list[str]
-        Source(s).
+    source : str, list[str], or None, optional
+        The source specification(s) to evaluate. Can be a single
+        source string, a list of source strings, or None.
 
     Returns
     -------
-    None
+    Any
+        The result of the local source evaluation, indicating
+        whether the source is local or remote.
     """
     return eval_local_source(source)
 
@@ -37,25 +44,33 @@ def process_kwargs(
     **kwargs,
 ) -> dict:
     """
-    Process spec kwargs.
+    Process and enhance specification parameters for model creation.
+
+    Processes the keyword arguments for model specification, handling
+    path generation and UUID assignment. If no path is provided, generates
+    a unique path based on project, entity type, name, and source.
 
     Parameters
     ----------
     project : str
-        Project name.
+        The name of the project containing the model.
     name : str
-        Object name.
-    source : str
-        Source(s).
-    path : str
-        Destination path of the entity. If not provided, it's generated.
+        The name of the model entity.
+    source : str or list[str]
+        The source specification(s) for the model content.
+        Can be a single source or multiple sources.
+    path : str, optional
+        The destination path for the model entity.
+        If None, a path will be automatically generated.
     **kwargs : dict
-        Spec parameters.
+        Additional specification parameters to be processed
+        and passed to the model creation.
 
     Returns
     -------
     dict
-        Kwargs updated.
+        The updated kwargs dictionary with processed path
+        and UUID information included.
     """
     if path is None:
         uuid = build_uuid()

digitalhub/entities/project/_base/entity.py

@@ -11,6 +11,7 @@ from typing import Any
 from digitalhub.context.api import build_context
 from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._constructors.uuid import build_uuid
 from digitalhub.entities._processors.base import base_processor
 from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.artifact.crud import (
@@ -290,7 +291,7 @@ class Project(Entity):
         # Return updated object
         return obj
 
-    def _import_entities(self, obj: dict) -> None:
+    def _import_entities(self, obj: dict, reset_id: bool = False) -> None:
         """
         Import project entities.
 
@@ -319,11 +320,19 @@ class Project(Entity):
                         try:
                             # Artifacts, Dataitems and Models
                             if entity_type in entity_types[:3]:
-                                context_processor.import_context_entity(ref)
+                                context_processor.import_context_entity(
+                                    file=ref,
+                                    reset_id=reset_id,
+                                    context=self.name,
+                                )
 
                             # Functions and Workflows
                             elif entity_type in entity_types[3:]:
-                                context_processor.import_executable_entity(ref)
+                                context_processor.import_executable_entity(
+                                    file=ref,
+                                    reset_id=reset_id,
+                                    context=self.name,
+                                )
 
                         except FileNotFoundError:
                             msg = f"File not found: {ref}."
@@ -335,6 +344,11 @@ class Project(Entity):
                     if entity["metadata"].get("embedded") is None:
                         entity["metadata"]["embedded"] = True
 
+                    if reset_id:
+                        new_id = build_uuid()
+                        entity["id"] = new_id
+                        entity["metadata"]["version"] = new_id
+
                     try:
                         factory.build_entity_from_dict(entity).save()
                     except EntityAlreadyExistsError:
@@ -616,8 +630,9 @@ class Project(Entity):
 
     def import_artifact(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Artifact:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -626,8 +641,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -638,7 +655,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_artifact("my-artifact.yaml")
         """
-        return import_artifact(file, **kwargs)
+        return import_artifact(file, key, reset_id, self.name)
 
     def update_artifact(self, entity: Artifact) -> Artifact:
         """
@@ -919,8 +936,9 @@ class Project(Entity):
 
     def import_dataitem(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Dataitem:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -929,8 +947,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -941,7 +961,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_dataitem("my-dataitem.yaml")
         """
-        return import_dataitem(file, **kwargs)
+        return import_dataitem(file, key, reset_id, self.name)
 
     def update_dataitem(self, entity: Dataitem) -> Dataitem:
         """
@@ -1211,8 +1231,9 @@ class Project(Entity):
 
     def import_model(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Model:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -1221,8 +1242,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -1233,7 +1256,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_model("my-model.yaml")
         """
-        return import_model(file, **kwargs)
+        return import_model(file, key, reset_id, self.name)
 
     def update_model(self, entity: Model) -> Model:
         """
@@ -1454,8 +1477,9 @@ class Project(Entity):
 
     def import_function(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Function:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -1464,8 +1488,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -1476,7 +1502,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_function("my-function.yaml")
         """
-        return import_function(file, **kwargs)
+        return import_function(file, key, reset_id, self.name)
 
     def update_function(self, entity: Function) -> Function:
         """
@@ -1700,8 +1726,9 @@ class Project(Entity):
 
     def import_workflow(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Workflow:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -1710,8 +1737,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -1722,7 +1751,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_workflow("my-workflow.yaml")
         """
-        return import_workflow(file, **kwargs)
+        return import_workflow(file, key, reset_id, self.name)
 
     def update_workflow(self, entity: Workflow) -> Workflow:
         """
@@ -1944,8 +1973,9 @@ class Project(Entity):
 
     def import_secret(
         self,
-        file: str,
-        **kwargs,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = True,
     ) -> Secret:
         """
         Import object from a YAML file and create a new object into the backend.
@@ -1954,8 +1984,10 @@ class Project(Entity):
         ----------
         file : str
             Path to YAML file.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        key : str
+            Entity key (store://...).
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
 
         Returns
         -------
@@ -1966,7 +1998,7 @@ class Project(Entity):
         --------
         >>> obj = project.import_secret("my-secret.yaml")
         """
-        return import_secret(file, **kwargs)
+        return import_secret(file, key, reset_id, self.name)
 
     def update_secret(self, entity: Secret) -> Secret:
         """

digitalhub/entities/project/crud.py

@@ -118,6 +118,7 @@ def import_project(
     file: str,
     local: bool = False,
     setup_kwargs: dict | None = None,
+    reset_id: bool = False,
 ) -> Project:
     """
     Import object from a YAML file and create a new object into the backend.
@@ -130,6 +131,8 @@ def import_project(
         Flag to determine if backend is local.
     setup_kwargs : dict
         Setup keyword arguments passed to setup_project() function.
+    reset_id : bool
+        Flag to determine if the ID of project entities should be reset.
 
     Returns
     -------
@@ -140,7 +143,11 @@ def import_project(
     --------
     >>> obj = import_project("my-project.yaml")
     """
-    obj = base_processor.import_project_entity(file=file, local=local)
+    obj = base_processor.import_project_entity(
+        file=file,
+        local=local,
+        reset_id=reset_id,
+    )
     return setup_project(obj, setup_kwargs)
 
 

digitalhub/entities/run/_base/entity.py

@@ -228,15 +228,35 @@ class Run(UnversionedEntity):
         -------
         None
 
+        Examples
+        --------
+        Log multiple metrics at once
+        >>> entity.log_metrics({"loss": 0.002, "accuracy": 0.95})
+
+        Log metrics with lists and single values
+        >>> entity.log_metrics({"loss": [0.1, 0.05], "epoch": 10})
+
+        Append to existing metrics (default behavior)
+        >>> entity.log_metrics({"loss": 0.001, "accuracy": 0.96})  # Appends to existing
+
+        Overwrite existing metrics
+        >>> entity.log_metrics({"loss": 0.0005, "accuracy": 0.98}, overwrite=True)
+
         See also
         --------
         log_metric
         """
         for key, value in metrics.items():
+            # For lists, use log_metric which handles appending correctly
             if isinstance(value, list):
                 self.log_metric(key, value, overwrite)
+
+            # For single values, check if we should append or create new
             else:
-                self.log_metric(key, value, overwrite, single_value=True)
+                if not overwrite and key in self.status.metrics:
+                    self.log_metric(key, value)
+                else:
+                    self.log_metric(key, value, overwrite, single_value=True)
 
     ##############################
     #  Helpers

digitalhub/entities/run/crud.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._commons.utils import is_valid_key
 from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.exceptions import EntityError
 
@@ -135,14 +136,25 @@ def list_runs(project: str, **kwargs) -> list[Run]:
     )
 
 
-def import_run(file: str) -> Run:
+def import_run(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Run:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -153,7 +165,12 @@ def import_run(file: str) -> Run:
     -------
     >>> obj = import_run("my-run.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_run(file: str) -> Run:
@@ -230,7 +247,7 @@ def delete_run(
     >>> obj = delete_run("store://my-run-key")
     >>> obj = delete_run("my-run-id", project="my-project")
     """
-    if not identifier.startswith("store://") and project is None:
+    if not is_valid_key(identifier) and project is None:
         raise EntityError("Specify entity key or entity ID combined with project")
     return context_processor.delete_context_entity(
         identifier=identifier,

digitalhub/entities/secret/crud.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._commons.utils import is_valid_key
 from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
@@ -111,7 +112,7 @@ def get_secret(
     >>>                  project="my-project",
     >>>                  entity_id="my-secret-id")
     """
-    if not identifier.startswith("store://"):
+    if not is_valid_key(identifier):
         if project is None:
             raise ValueError("Project must be provided.")
         secrets = list_secrets(project=project, **kwargs)
@@ -195,14 +196,25 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     )
 
 
-def import_secret(file: str) -> Secret:
+def import_secret(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Secret:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -213,7 +225,12 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_secret(file: str) -> Secret:

digitalhub/entities/task/crud.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._commons.utils import is_valid_key
 from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.exceptions import EntityError
 
@@ -134,14 +135,25 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
     )
 
 
-def import_task(file: str) -> Task:
+def import_task(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Task:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -152,7 +164,12 @@ def import_task(file: str) -> Task:
     -------
     >>> obj = import_task("my-task.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_task(file: str) -> Task:
@@ -243,7 +260,7 @@ def delete_task(
     >>>                  project="my-project",
     >>>                  delete_all_versions=True)
     """
-    if not identifier.startswith("store://"):
+    if not is_valid_key(identifier):
         raise EntityError("Task has no name. Use key instead.")
     return context_processor.delete_context_entity(
         identifier=identifier,

digitalhub/entities/trigger/crud.py

@@ -197,14 +197,25 @@ def list_triggers(project: str, **kwargs) -> list[Trigger]:
     )
 
 
-def import_trigger(file: str) -> Trigger:
+def import_trigger(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Trigger:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -215,7 +226,12 @@ def import_trigger(file: str) -> Trigger:
     --------
     >>> obj = import_trigger("my-trigger.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_trigger(file: str) -> Trigger:

digitalhub/entities/workflow/_base/entity.py

@@ -73,7 +73,7 @@ class Workflow(ExecutableEntity):
         """
         # Get task and run kind
         task_kind = factory.get_task_kind_from_action(self.kind, action)
-        run_kind = factory.get_run_kind(self.kind)
+        run_kind = factory.get_run_kind_from_action(self.kind, action)
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)