digitalhub 0.11.0b7__py3-none-any.whl → 0.13.0__py3-none-any.whl

digitalhub/entities/dataitem/utils.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import shutil
@@ -29,16 +33,39 @@ def eval_source(
     project: str | None = None,
 ) -> Any:
     """
-    Evaluate if source is local.
+    Evaluate and process data source for dataitem creation.
+
+    Determines the appropriate source handling based on whether a source
+    path or data object is provided. For table dataitems with data objects,
+    writes the data to a Parquet file and returns the file path.
 
     Parameters
     ----------
-    source : SourcesOrListOfSources
-        Source(s).
+    source : SourcesOrListOfSources, optional
+        The source specification(s) for the dataitem. Can be file paths,
+        URLs, or other source identifiers.
+    data : Any, optional
+        The data object to process (e.g., DataFrame). Alternative to source.
+        Exactly one of source or data must be provided.
+    kind : str, optional
+        The kind of dataitem being created (e.g., 'table').
+    name : str, optional
+        The name of the dataitem, used for generating file paths.
+    project : str, optional
+        The project name, used for context and path generation.
 
     Returns
     -------
-    None
+    Any
+        The processed source. Returns the original source if provided,
+        or the path to a generated file if data was processed.
+
+    Raises
+    ------
+    ValueError
+        If both source and data are provided or both are None.
+    NotImplementedError
+        If the specified kind is not supported for data processing.
     """
     if (source is None) == (data is None):
         raise ValueError("You must provide source or data.")
@@ -58,7 +85,6 @@ def eval_source(
 
 
 def eval_data(
-    project: str,
     kind: str,
     source: SourcesOrListOfSources,
     data: Any | None = None,
@@ -66,28 +92,36 @@ def eval_data(
     engine: str | None = None,
 ) -> Any:
     """
-    Evaluate data is loaded.
+    Evaluate and load data from source or return provided data.
+
+    For table dataitems, loads data from the source using the appropriate
+    store and reader. For other kinds, returns the data as-is.
 
     Parameters
     ----------
-    project : str
-        Project name.
-    source : str
-        Source(s).
-    data : Any
-        Dataframe to log. Alternative to source.
-    file_format : str
-        Extension of the file.
-    engine : str
-        Engine to use.
+    kind : str
+        The kind of dataitem (e.g., 'table') that determines
+        how data should be processed.
+    source : SourcesOrListOfSources
+        The source specification(s) to load data from.
+    data : Any, optional
+        Pre-loaded data object. If provided, may be returned directly
+        depending on the dataitem kind.
+    file_format : str, optional
+        The file format specification for reading the source
+        (e.g., 'parquet', 'csv').
+    engine : str, optional
+        The engine to use for reading the data (e.g., 'pandas', 'polars').
 
     Returns
     -------
-    None
+    Any
+        The loaded data object for table dataitems, or the original
+        data parameter for other kinds.
     """
     if kind == EntityKinds.DATAITEM_TABLE.value:
         if data is None:
-            return get_store(project, source).read_df(
+            return get_store(source).read_df(
                 source,
                 file_format=file_format,
                 engine=engine,
@@ -105,29 +139,37 @@ def process_kwargs(
     **kwargs,
 ) -> dict:
     """
-    Process spec kwargs.
+    Process and enhance specification parameters for dataitem creation.
+
+    Processes the keyword arguments for dataitem specification, handling
+    schema extraction for table dataitems and path generation. Extracts
+    schema information from data objects when available.
 
     Parameters
     ----------
     project : str
-        Project name.
+        The name of the project.
     name : str
-        Object name.
+        The name of the dataitem entity.
     kind : str
-        Kind the object.
+        The kind of dataitem being created (e.g., 'table').
     source : SourcesOrListOfSources
-        Source(s).
-    data : Any
-        Dataframe to log. Alternative to source.
-    path : str
-        Destination path of the entity. If not provided, it's generated.
+        The source specification(s) for the dataitem content.
+    data : Any, optional
+        The data object for schema extraction and processing.
+        Used as an alternative to source for table dataitems.
+    path : str, optional
+        The destination path for the dataitem entity.
+        If None, a path will be automatically generated.
     **kwargs : dict
-        Spec parameters.
+        Additional specification parameters to be processed
+        and passed to the dataitem creation.
 
     Returns
     -------
     dict
-        Kwargs updated.
+        The updated kwargs dictionary with processed path,
+        UUID, and schema information included.
     """
     if data is not None:
         if kind == EntityKinds.DATAITEM_TABLE.value:
@@ -144,12 +186,17 @@ def process_kwargs(
 
 def clean_tmp_path(pth: SourcesOrListOfSources) -> None:
     """
-    Clean temporary path.
+    Clean up temporary files and directories.
+
+    Removes temporary files or directories created during dataitem
+    processing. Handles both single paths and lists of paths,
+    ignoring any errors that occur during cleanup.
 
     Parameters
     ----------
     pth : SourcesOrListOfSources
-        Path to clean.
+        The path or list of paths to clean up. Can be file paths
+        or directory paths that need to be removed.
 
     Returns
     -------
@@ -164,19 +211,25 @@ def clean_tmp_path(pth: SourcesOrListOfSources) -> None:
 
 def post_process(obj: Dataitem, data: Any) -> Dataitem:
     """
-    Post process object.
+    Post-process dataitem object with additional metadata and previews.
+
+    Enhances the dataitem object with additional information extracted
+    from the data. For table dataitems, generates and stores a data
+    preview in the object's status.
 
     Parameters
     ----------
     obj : Dataitem
-        The object.
+        The dataitem object to post-process and enhance.
     data : Any
-        The data.
+        The data object used to generate previews and extract
+        additional metadata information.
 
     Returns
     -------
     Dataitem
-        The object.
+        The enhanced dataitem object with updated status information
+        and saved changes.
     """
     if obj.kind == EntityKinds.DATAITEM_TABLE.value:
         reader = get_reader_by_object(data)

digitalhub/entities/function/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/function/_base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/function/_base/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/function/_base/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/function/_base/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator

digitalhub/entities/function/_base/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._base.entity.status import Status

digitalhub/entities/function/crud.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/_base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/_base/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/_base/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/_base/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional

digitalhub/entities/model/_base/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._base.material.status import MaterialStatus

digitalhub/entities/model/crud.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing
@@ -306,6 +310,7 @@ def delete_model(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
+    cascade: bool = True,
     **kwargs,
 ) -> dict:
     """
@@ -321,6 +326,8 @@ def delete_model(
         Entity ID.
     delete_all_versions : bool
         Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    cascade : bool
+        Cascade delete.
     **kwargs : dict
         Parameters to pass to the API call.
 
@@ -345,5 +352,6 @@ def delete_model(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
+        cascade=cascade,
         **kwargs,
     )

digitalhub/entities/model/huggingface/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/huggingface/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import EntityKinds

digitalhub/entities/model/huggingface/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/huggingface/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional

digitalhub/entities/model/huggingface/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.status import ModelStatus

digitalhub/entities/model/mlflow/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/mlflow/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import EntityKinds

digitalhub/entities/model/mlflow/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/mlflow/models.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional

digitalhub/entities/model/mlflow/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional

digitalhub/entities/model/mlflow/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.status import ModelStatus

digitalhub/entities/model/mlflow/utils.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/model/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/model/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import EntityKinds

digitalhub/entities/model/model/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/model/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator

digitalhub/entities/model/model/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.status import ModelStatus

digitalhub/entities/model/sklearn/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/model/sklearn/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import EntityKinds

digitalhub/entities/model/sklearn/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing

digitalhub/entities/model/sklearn/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.spec import ModelSpec, ModelValidator

digitalhub/entities/model/sklearn/status.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities.model._base.status import ModelStatus

digitalhub/entities/model/utils.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Any
@@ -11,16 +15,23 @@ 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)
 
@@ -33,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/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/project/_base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/project/_base/builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._base.entity.builder import EntityBuilder

digitalhub/entities/project/_base/entity.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing
@@ -2088,8 +2092,6 @@ class Project(Entity):
         --------
         >>> objs = project.list_runs()
         """
-        if kwargs is None:
-            kwargs = {}
         return list_runs(self.name, **kwargs)
 
     def delete_run(

digitalhub/entities/project/_base/models.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional

digitalhub/entities/project/_base/spec.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Optional