digitalhub 0.14.0b0__py3-none-any.whl → 0.14.0b2__py3-none-any.whl

digitalhub/entities/model/_base/entity.py

@@ -88,19 +88,37 @@ class Model(MaterialEntity):
         Examples
         --------
         Log a new value in a list
-        >>> entity.log_metric("loss", 0.002)
+        >>> entity.log_metric(
+        ...     "loss", 0.002
+        ... )
 
         Append a new value in a list
-        >>> entity.log_metric("loss", 0.0019)
+        >>> 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])
+        >>> 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)
+        >>> 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)
+        >>> 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])
@@ -128,16 +146,40 @@ class Model(MaterialEntity):
         Examples
         --------
         Log multiple metrics at once
-        >>> entity.log_metrics({"loss": 0.002, "accuracy": 0.95})
+        >>> 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})
+        >>> 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
+        >>> 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)
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.0005,
+        ...         "accuracy": 0.98,
+        ...     },
+        ...     overwrite=True,
+        ... )
 
         See also
         --------

digitalhub/entities/model/crud.py

@@ -155,7 +155,9 @@ def get_model(
     Examples
     --------
     Using entity key:
-    >>> obj = get_model("store://my-model-key")
+    >>> obj = get_model(
+    ...     "store://my-model-key"
+    ... )
 
     Using entity name:
     >>> obj = get_model("my-model-name"
@@ -196,7 +198,9 @@ def get_model_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_model_versions("store://my-model-key")
+    >>> objs = get_model_versions(
+    ...     "store://my-model-key"
+    ... )
 
     Using entity name:
     >>> objs = get_model_versions("my-model-name",
@@ -228,7 +232,9 @@ def list_models(project: str, **kwargs) -> list[Model]:
 
     Examples
     --------
-    >>> objs = list_models(project="my-project")
+    >>> objs = list_models(
+    ...     project="my-project"
+    ... )
     """
     return context_processor.list_context_entities(
         project=project,
@@ -264,7 +270,9 @@ def import_model(
 
     Examples
     --------
-    >>> obj = import_model("my-model.yaml")
+    >>> obj = import_model(
+    ...     "my-model.yaml"
+    ... )
     """
     return context_processor.import_context_entity(
         file,
@@ -290,7 +298,9 @@ def load_model(file: str) -> Model:
 
     Examples
     --------
-    >>> obj = load_model("my-model.yaml")
+    >>> obj = load_model(
+    ...     "my-model.yaml"
+    ... )
     """
     return context_processor.load_context_entity(file)
 
@@ -311,7 +321,9 @@ def update_model(entity: Model) -> Model:
 
     Examples
     --------
-    >>> obj = get_model("store://my-model-key")
+    >>> obj = get_model(
+    ...     "store://my-model-key"
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -355,7 +367,9 @@ def delete_model(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_model("store://my-model-key")
+    >>> obj = delete_model(
+    ...     "store://my-model-key"
+    ... )
 
     Otherwise:
     >>> obj = delete_model("my-model-name",

digitalhub/entities/project/_base/entity.py

@@ -72,7 +72,7 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
-from digitalhub.factory.factory import factory
+from digitalhub.factory.entity import entity_factory
 from digitalhub.stores.client.api import get_client
 from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
 from digitalhub.utils.generic_utils import get_timestamp
@@ -350,7 +350,7 @@ class Project(Entity):
                         entity["metadata"]["version"] = new_id
 
                     try:
-                        factory.build_entity_from_dict(entity).save()
+                        entity_factory.build_entity_from_dict(entity).save()
                     except EntityAlreadyExistsError:
                         pass
 
@@ -563,7 +563,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_artifact("store://my-artifact-key")
+        >>> obj = project.get_artifact(
+        ...     "store://my-artifact-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_artifact("my-artifact-name"
@@ -601,10 +603,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_artifact_versions("store://my-artifact-key")
+        >>> obj = project.get_artifact_versions(
+        ...     "store://my-artifact-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_artifact_versions("my-artifact-name")
+        >>> obj = project.get_artifact_versions(
+        ...     "my-artifact-name"
+        ... )
         """
         return get_artifact_versions(identifier, project=self.name, **kwargs)
 
@@ -653,7 +659,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_artifact("my-artifact.yaml")
+        >>> obj = project.import_artifact(
+        ...     "my-artifact.yaml"
+        ... )
         """
         return import_artifact(file, key, reset_id, self.name)
 
@@ -673,7 +681,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_artifact(obj)
+        >>> obj = project.update_artifact(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -708,7 +718,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_artifact("store://my-artifact-key")
+        >>> project.delete_artifact(
+        ...     "store://my-artifact-key"
+        ... )
 
         Otherwise:
         >>> project.delete_artifact("my-artifact-name",
@@ -869,7 +881,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_dataitem("store://my-dataitem-key")
+        >>> obj = project.get_dataitem(
+        ...     "store://my-dataitem-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_dataitem("my-dataitem-name"
@@ -907,10 +921,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_dataitem_versions("store://my-dataitem-key")
+        >>> obj = project.get_dataitem_versions(
+        ...     "store://my-dataitem-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_dataitem_versions("my-dataitem-name")
+        >>> obj = project.get_dataitem_versions(
+        ...     "my-dataitem-name"
+        ... )
         """
         return get_dataitem_versions(identifier, project=self.name, **kwargs)
 
@@ -959,7 +977,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_dataitem("my-dataitem.yaml")
+        >>> obj = project.import_dataitem(
+        ...     "my-dataitem.yaml"
+        ... )
         """
         return import_dataitem(file, key, reset_id, self.name)
 
@@ -979,7 +999,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_dataitem(obj)
+        >>> obj = project.update_dataitem(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1014,7 +1036,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_dataitem("store://my-dataitem-key")
+        >>> project.delete_dataitem(
+        ...     "store://my-dataitem-key"
+        ... )
 
         Otherwise:
         >>> project.delete_dataitem("my-dataitem-name",
@@ -1164,7 +1188,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_model("store://my-model-key")
+        >>> obj = project.get_model(
+        ...     "store://my-model-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_model("my-model-name"
@@ -1202,10 +1228,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_model_versions("store://my-model-key")
+        >>> obj = project.get_model_versions(
+        ...     "store://my-model-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_model_versions("my-model-name")
+        >>> obj = project.get_model_versions(
+        ...     "my-model-name"
+        ... )
         """
         return get_model_versions(identifier, project=self.name, **kwargs)
 
@@ -1254,7 +1284,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_model("my-model.yaml")
+        >>> obj = project.import_model(
+        ...     "my-model.yaml"
+        ... )
         """
         return import_model(file, key, reset_id, self.name)
 
@@ -1274,7 +1306,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_model(obj)
+        >>> obj = project.update_model(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1309,7 +1343,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_model("store://my-model-key")
+        >>> project.delete_model(
+        ...     "store://my-model-key"
+        ... )
 
         Otherwise:
         >>> project.delete_model("my-model-name",
@@ -1410,7 +1446,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_function("store://my-function-key")
+        >>> obj = project.get_function(
+        ...     "store://my-function-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_function("my-function-name"
@@ -1448,10 +1486,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_function_versions("store://my-function-key")
+        >>> obj = project.get_function_versions(
+        ...     "store://my-function-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_function_versions("my-function-name")
+        >>> obj = project.get_function_versions(
+        ...     "my-function-name"
+        ... )
         """
         return get_function_versions(identifier, project=self.name, **kwargs)
 
@@ -1500,7 +1542,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_function("my-function.yaml")
+        >>> obj = project.import_function(
+        ...     "my-function.yaml"
+        ... )
         """
         return import_function(file, key, reset_id, self.name)
 
@@ -1520,7 +1564,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_function(obj)
+        >>> obj = project.update_function(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1558,7 +1604,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_function("store://my-function-key")
+        >>> project.delete_function(
+        ...     "store://my-function-key"
+        ... )
 
         Otherwise:
         >>> project.delete_function("my-function-name",
@@ -1659,7 +1707,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_workflow("store://my-workflow-key")
+        >>> obj = project.get_workflow(
+        ...     "store://my-workflow-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_workflow("my-workflow-name"
@@ -1697,10 +1747,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_workflow_versions("store://my-workflow-key")
+        >>> obj = project.get_workflow_versions(
+        ...     "store://my-workflow-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_workflow_versions("my-workflow-name")
+        >>> obj = project.get_workflow_versions(
+        ...     "my-workflow-name"
+        ... )
         """
         return get_workflow_versions(identifier, project=self.name, **kwargs)
 
@@ -1749,7 +1803,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_workflow("my-workflow.yaml")
+        >>> obj = project.import_workflow(
+        ...     "my-workflow.yaml"
+        ... )
         """
         return import_workflow(file, key, reset_id, self.name)
 
@@ -1769,7 +1825,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_workflow(obj)
+        >>> obj = project.update_workflow(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1807,7 +1865,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_workflow("store://my-workflow-key")
+        >>> project.delete_workflow(
+        ...     "store://my-workflow-key"
+        ... )
 
         Otherwise:
         >>> project.delete_workflow("my-workflow-name",
@@ -1906,7 +1966,9 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_secret("store://my-secret-key")
+        >>> obj = project.get_secret(
+        ...     "store://my-secret-key"
+        ... )
 
         Using entity name:
         >>> obj = project.get_secret("my-secret-name"
@@ -1944,10 +2006,14 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_secret_versions("store://my-secret-key")
+        >>> obj = project.get_secret_versions(
+        ...     "store://my-secret-key"
+        ... )
 
         Using entity name:
-        >>> obj = project.get_secret_versions("my-secret-name")
+        >>> obj = project.get_secret_versions(
+        ...     "my-secret-name"
+        ... )
         """
         return get_secret_versions(identifier, project=self.name, **kwargs)
 
@@ -1996,7 +2062,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_secret("my-secret.yaml")
+        >>> obj = project.import_secret(
+        ...     "my-secret.yaml"
+        ... )
         """
         return import_secret(file, key, reset_id, self.name)
 
@@ -2016,7 +2084,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_secret(obj)
+        >>> obj = project.update_secret(
+        ...     obj
+        ... )
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -2051,7 +2121,9 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_secret("store://my-secret-key")
+        >>> project.delete_secret(
+        ...     "store://my-secret-key"
+        ... )
 
         Otherwise:
         >>> project.delete_secret("my-secret-name",
@@ -2093,10 +2165,16 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_run("store://my-secret-key")
+        >>> obj = project.get_run(
+        ...     "store://my-secret-key"
+        ... )
 
         Using entity ID:
-        >>> obj = project.get_run("123")
+        >>> obj = (
+        ...     project.get_run(
+        ...         "123"
+        ...     )
+        ... )
         """
         obj = get_run(
             identifier=identifier,
@@ -2148,7 +2226,9 @@ class Project(Entity):
 
         Examples
         --------
-        >>> project.delete_run("store://my-run-key")
+        >>> project.delete_run(
+        ...     "store://my-run-key"
+        ... )
 
         """
         delete_run(

digitalhub/entities/project/crud.py

@@ -59,7 +59,9 @@ def new_project(
 
     Examples
     --------
-    >>> obj = new_project("my-project")
+    >>> obj = new_project(
+    ...     "my-project"
+    ... )
     """
     if context is None:
         context = "./"
@@ -103,7 +105,9 @@ def get_project(
 
     Examples
     --------
-    >>> obj = get_project("my-project")
+    >>> obj = get_project(
+    ...     "my-project"
+    ... )
     """
     obj = base_processor.read_project_entity(
         entity_type=ENTITY_TYPE,
@@ -141,7 +145,9 @@ def import_project(
 
     Examples
     --------
-    >>> obj = import_project("my-project.yaml")
+    >>> obj = import_project(
+    ...     "my-project.yaml"
+    ... )
     """
     obj = base_processor.import_project_entity(
         file=file,
@@ -175,7 +181,9 @@ def load_project(
 
     Examples
     --------
-    >>> obj = load_project("my-project.yaml")
+    >>> obj = load_project(
+    ...     "my-project.yaml"
+    ... )
     """
     obj = base_processor.load_project_entity(file=file, local=local)
     return setup_project(obj, setup_kwargs)
@@ -267,7 +275,11 @@ def update_project(entity: Project, **kwargs) -> Project:
 
     Examples
     --------
-    >>> obj = update_project(obj)
+    >>> obj = (
+    ...     update_project(
+    ...         obj
+    ...     )
+    ... )
     """
     return base_processor.update_project_entity(
         entity_type=entity.ENTITY_TYPE,
@@ -308,7 +320,9 @@ def delete_project(
 
     Examples
     --------
-    >>> delete_project("my-project")
+    >>> delete_project(
+    ...     "my-project"
+    ... )
     """
     return base_processor.delete_project_entity(
         entity_type=ENTITY_TYPE,