craft-ai-sdk 0.67.0rc1__tar.gz → 0.67.1rc1__tar.gz

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: craft-ai-sdk
-Version: 0.67.0rc1
+Version: 0.67.1rc1
 Summary: Craft AI MLOps platform SDK
 License: Apache-2.0
 Author: Craft AI

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/craft_ai_sdk/__init__.py

@@ -13,4 +13,4 @@ from .io import (  # noqa: F401
 )
 from .sdk import CraftAiSdk  # noqa: F401
 
-__version__ = "0.67.0rc1"
+__version__ = "0.67.1rc1"

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/craft_ai_sdk/core/data_store.py

@@ -1,5 +1,5 @@
 import io
-from typing import TypedDict, Union
+from typing import IO, Iterable, TypedDict, Union
 
 import requests
 
@@ -46,17 +46,17 @@ def get_data_store_object_information(
     return result
 
 
-def list_data_store_objects(
+def iter_data_store_objects(
     sdk: BaseCraftAiSdk, folder_path: Union[str, None] = None
-) -> list[DataStoreObjectInformation]:
-    """Get the list of the objects stored in the data store.
+) -> Iterable[DataStoreObjectInformation]:
+    """Get an iterable returning every objects stored in the data store.
 
     Args:
         folder_path (:obj:`str`, optional): Location of the requested folder in the data
             store.
 
     Returns:
-        :obj:`list` of :obj:`dict`: List of objects in the data store represented
+        :obj:`Iterable` of :obj:`dict`: List of objects in the data store represented
         as :obj:`dict` with the following keys:
 
             * ``"path"`` (:obj:`str`): Location of the object in the data store.
@@ -66,16 +66,37 @@ def list_data_store_objects(
     """
     url = f"{sdk.base_environment_api_url}/data-store/list"
     params = {"folder_path": folder_path} if folder_path else {}
-    result = sdk._get(url, params=params)
-    all_items = result["items"]
-    while result.get("continuation_token", None):
-        params = {"continuation_token": result["continuation_token"], **params}
+    while True:
         result = sdk._get(url, params=params)
-        all_items.extend(result["items"])
+        for object in result["items"]:
+            object["size"] = convert_size(object["size"])
+            yield object
+        continuation_token = result.get("continuation_token", None)
+        if continuation_token is None:
+            return
+        else:
+            params = {"continuation_token": continuation_token, **params}
+
+
+def list_data_store_objects(
+    sdk: BaseCraftAiSdk, folder_path: Union[str, None] = None
+) -> list[DataStoreObjectInformation]:
+    """Get the list of the objects stored in the data store.
+
+    Args:
+        folder_path (:obj:`str`, optional): Location of the requested folder in the data
+            store.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of objects in the data store represented
+        as :obj:`dict` with the following keys:
 
-    for object in all_items:
-        object["size"] = convert_size(object["size"])
-    return all_items
+            * ``"path"`` (:obj:`str`): Location of the object in the data store.
+            * ``"last_modified"`` (:obj:`str`): The creation date or last
+              modification date in ISO format.
+            * ``"size"`` (:obj:`int`): The size of the object in bytes.
+    """
+    return list(iter_data_store_objects(sdk, folder_path))
 
 
 def _get_upload_presigned_url(sdk: BaseCraftAiSdk, object_path_in_datastore: str):
@@ -205,7 +226,7 @@ def _get_download_presigned_url(
 def download_data_store_object(
     sdk: BaseCraftAiSdk,
     object_path_in_datastore: str,
-    filepath_or_buffer: Union[str, io.IOBase],
+    filepath_or_buffer: Union[str, IO, io.IOBase],
 ):
     """Download an object in the data store and save it into a file.
 

craft_ai_sdk-0.67.1rc1/craft_ai_sdk/core/pipeline_templates.py

@@ -0,0 +1,126 @@
+from typing import TypedDict
+
+from craft_ai_sdk.sdk import BaseCraftAiSdk
+
+
+class PipelineTemplateReference(TypedDict):
+    name: str
+    version: str
+    display_name: str
+    description: str
+    hosting_type: str
+    model_family: str
+
+
+class PipelineTemplate(PipelineTemplateReference):
+    enabled: bool
+
+
+class PipelineTemplateDetails(PipelineTemplate):
+    inputs: list[dict]
+    outputs: list[dict]
+    recommended_inputs_mapping: list[dict]
+    recommended_outputs_mapping: list[dict]
+
+
+def list_pipeline_templates(sdk: BaseCraftAiSdk) -> list[PipelineTemplate]:
+    """List all the available pipeline templates.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of available pipeline templates represented
+        as a dict with the following keys:
+
+        * ``"name"`` (:obj:`str`): Name of the pipeline template used as an
+            identifier to create the pipeline.
+        * ``"version"`` (:obj:`str`): Version of the pipeline template.
+        * ``"enabled"`` (:obj:`bool`): Whether the pipeline template can be used to
+            create pipelines or not.
+        * ``"display_name"`` (:obj:`str`): Display name of the pipeline
+            template.
+        * ``"description"`` (:obj:`str`): Description of the pipeline template.
+        * ``"hosting_type"`` (:obj:`str`): Either ``"self-hosted"`` if the model
+            runs on the environment's infrastructure, or ``"private-api"`` if the
+            model inference is done through an external API.
+        * ``"model_family"`` (:obj:`str`): Model family of the pipeline
+            template.
+    """
+
+    url = f"{sdk.base_environment_api_url}/pipeline-templates"
+    response = sdk._get(url)
+    return response["pipeline_templates"]
+
+
+def get_pipeline_template(sdk: BaseCraftAiSdk, pipeline_template_name: str):
+    """Get information about a specific pipeline template. A pipeline template
+    could be used to create a pipeline.
+
+    Args:
+        pipeline_template_name (str): Name of the pipeline template to retrieve.
+
+    Returns:
+        :obj:`dict`: Information on the pipeline template represented as dict
+        with the following keys:
+
+        * ``"name"`` (:obj:`str`): Name of the pipeline template used as an
+            identifier to create the pipeline.
+        * ``"version"`` (:obj:`str`): Version of the pipeline template.
+        * ``"enabled"`` (:obj:`bool`): Whether the pipeline template can be used to
+            create pipelines or not.
+        * ``"display_name"`` (:obj:`str`): Display name of the pipeline
+            template.
+        * ``"description"`` (:obj:`str`): Description of the pipeline template.
+        * ``"hosting_type"`` (:obj:`str`): Either ``"self-hosted"`` if the model
+            runs on the environment's infrastructure, or ``"private-api"`` if the
+            model inference is done through an external API.
+        * ``"model_family"`` (:obj:`str`): Model family of the pipeline
+            template.
+        * ``"inputs"`` (:obj:`list` of :obj:`dict`): List of inputs of the pipeline
+            once created represented as a dict with the following keys:
+
+          * ``"name"`` (:obj:`str`): Input name.
+          * ``"data_type"`` (:obj:`str`): Input data type.
+          * ``"is_required"`` (:obj:`bool`): Whether the input is required.
+          * ``"default_value"`` (:obj:`str`): Input default value.
+          * ``"description"`` (:obj:`str`): Output description.
+
+        * ``"outputs"`` (:obj:`list` of :obj:`dict`): List of outputs of the pipeline
+          once created represented as a dict with the following keys:
+
+          * ``"name"`` (:obj:`str`): Output name.
+          * ``"data_type"`` (:obj:`str`): Output data type.
+          * ``"description"`` (:obj:`str`): Output description.
+
+        * ``"recommended_inputs_mapping"`` (:obj:`list` of :obj:`dict`):
+          List of recommended inputs mapping for creating a deployment represented
+          as a dict with the following keys:
+
+          * ``"pipeline_input_name"`` (:obj:`str`): Name of the input.
+          * ``"data_type`` (:obj:`str`): Data type of the input.
+          * ``"source`` (:obj:`str`): Source of type of the input. Can be
+            "environment_variable", "datastore", "constant", "is_null" "endpoint"
+            or "run".
+          * ``"endpoint_input_name"`` (:obj:`str`): Name of the input in the
+            endpoint execution if source is "endpoint".
+          * ``"constant_value"`` (:obj:`str`): Value of the constant if source is
+            "constant".
+          * ``"environment_variable_name"`` (:obj:`str`): Name of the environment
+            variable if source is "environment_variable".
+          * ``"is_null"`` (:obj:`bool`): True if source is "is_null".
+          * ``"value"``: Value of the input.
+
+        * ``"recommended_outputs_mapping"`` (:obj:`list` of :obj:`dict`):
+          List of recommended outputs mapping for creating a deployment represented
+          as a dict with the following keys:
+
+          * ``"pipeline_output_name"`` (:obj:`str`): Name of the output.
+          * ``"data_type`` (:obj:`str`): Data type of the output.
+          * ``"destination`` (:obj:`str`): Destination of type of the output. Can be
+            "datastore", "is_null" "endpoint" or "run".
+          * ``"endpoint_output_name"`` (:obj:`str`): Name of the output in the
+            endpoint execution if destination is "endpoint".
+          * ``"is_null"`` (:obj:`bool`): True if destination is "is_null".
+          * ``"value"``: Value of the output.
+    """
+
+    url = f"{sdk.base_environment_api_url}/pipeline-templates/{pipeline_template_name}"
+    return sdk._get(url)

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/craft_ai_sdk/core/pipelines.py

@@ -1,10 +1,11 @@
 import os
 import warnings
-from typing import TypedDict, Union, cast
+from typing import TypedDict, Union, cast, overload
 
 import requests
 from typing_extensions import NotRequired
 
+from craft_ai_sdk.core.pipeline_templates import PipelineTemplateReference
 from craft_ai_sdk.io import Input, Output
 from craft_ai_sdk.shared.types import Log
 
@@ -33,16 +34,6 @@ class PipelineParameter(TypedDict):
     container_config: ContainerConfig
 
 
-class PipelineTemplateReference(TypedDict):
-    id: str
-    name: str
-    version: str
-    display_name: str
-    description: str
-    hosting_type: str
-    model_family: str
-
-
 class PipelineCreationInfo(StepCreationInfo):
     last_execution_id: str
     pipeline_template: Union[PipelineTemplateReference, None]
@@ -73,6 +64,24 @@ class PipelineDeleted(TypedDict):
     deployments: list[PipelineDeletedDeployment]
 
 
+def _create_pipeline_from_template(
+    sdk: BaseCraftAiSdk, pipeline_name: str, pipeline_template_name: str
+) -> None:
+    url = f"{sdk.base_environment_api_url}/pipelines"
+    body = {
+        "pipeline_name": pipeline_name,
+        "pipeline_template_name": pipeline_template_name,
+    }
+
+    log_action(
+        sdk,
+        f'Please wait while pipeline "{pipeline_name}" is being created. '
+        "This may take a while...",
+    )
+
+    sdk._post(url, json=body, allow_redirects=False)
+
+
 def _create_pipeline_with_step(
     sdk: BaseCraftAiSdk, pipeline_name: str, step_name: str
 ) -> Pipeline:
@@ -87,6 +96,28 @@ def _create_pipeline_with_step(
     )
 
 
+@overload
+def create_pipeline(
+    sdk: BaseCraftAiSdk,
+    pipeline_name: str,
+    function_path: Union[str, None] = None,
+    function_name: Union[str, None] = None,
+    description: Union[str, None] = None,
+    container_config: Union[ContainerConfig, None] = None,
+    inputs: Union[list[Input], None] = None,
+    outputs: Union[list[Output], None] = None,
+    wait_for_completion: bool = True,
+    timeout_s: Union[int, None] = None,
+) -> Pipeline: ...
+@overload
+def create_pipeline(
+    sdk: BaseCraftAiSdk,
+    pipeline_name: str,
+    *,
+    pipeline_template_name: str,
+    wait_for_completion: bool = True,
+    timeout_s: Union[int, None] = None,
+) -> Pipeline: ...
 @log_func_result("Pipeline creation")
 def create_pipeline(
     sdk: BaseCraftAiSdk,
@@ -97,19 +128,35 @@ def create_pipeline(
     container_config: Union[ContainerConfig, None] = None,
     inputs: Union[list[Input], None] = None,
     outputs: Union[list[Output], None] = None,
-    wait_for_completion=True,
+    wait_for_completion: bool = True,
     timeout_s: Union[int, None] = None,
+    *,
+    pipeline_template_name: Union[str, None] = None,
     **kwargs,
-):
-    """Create a pipeline from a function located on a remote repository or locally.
+) -> Pipeline:
+    """Create a pipeline via two main creation modes:
+
+    **Function-based pipeline creation**
+      Create a pipeline from a function located on a remote repository or locally.
+      It requires :obj:`function_path` and :obj:`function_name` parameters
+      to be specified.
+
+      Use :obj:`CREATION_PARAMETER_VALUE` to explicitly set a value to null or fall back
+      on project information.
+      You can also use :obj:`container_config.included_folders` to specify the files and
+      folders required for the pipeline execution. This is useful if your repository
+      contains large files that are not required for the pipeline execution, such as
+      documentation or test files. Indeed there is a maximum limit of 5MB for the
+      total size of the content specified with :obj:`included_folders`.
+
+    **Template-based pipeline creation**
+      Create a pipeline from a predefined pipeline template by specifying the
+      :obj:`pipeline_template_name`. Function parameters should not be specified in
+      this case, as the template defines them.
+
+    In both cases, there are two optional parameters to control the pipeline creation
+    process: :obj:`wait_for_completion` and :obj:`timeout_s`.
 
-    Use :obj:`CREATION_PARAMETER_VALUE` to explicitly set a value to null or fall back
-    on project information.
-    You can also use :obj:`container_config.included_folders` to specify the files and
-    folders required for the pipeline execution. This is useful if your repository
-    contains large files that are not required for the pipeline execution, such as
-    documentation or test files. Indeed there is a maximum limit of 5MB for the
-    total size of the content specified with :obj:`included_folders`.
 
     Args:
         pipeline_name (:obj:`str`): Name of the pipeline to be created.
@@ -169,6 +216,9 @@ def create_pipeline(
             :obj:`dict` with the name of the output as keys and the value of the
             output as values. Each output should be specified as an instance
             of :class:`Output` via this parameter `outputs`.
+
+        pipeline_template_name (:obj:`str`, keyword-only): Name of the pipeline template
+            to use.
         wait_for_completion (:obj:`bool`, optional): Whether to wait for the pipeline
             to be created. Defaults to ``True``.
         timeout_s (:obj:`int`): Maximum time (in seconds) to wait for the pipeline to
@@ -229,9 +279,44 @@ def create_pipeline(
           * ``"status"`` (:obj:`str`): either ``"creation_pending"`` or ``"ready"``.
           * ``"origin"`` (:obj:`str`): The origin of the pipeline, can be
             ``"git_repository"`` or ``"local"``.
+          * ``"pipeline_template"`` (:obj:`dict` or :obj:`None`): The pipeline template
+            used to create the pipeline, :obj:`None` if the pipeline was not created
+            from a template. If not :obj:`None`, the dictionary has the following keys:
+
+            * ``"name"`` (:obj:`str`): Name of the pipeline template used as an
+              identifier to create the pipeline.
+            * ``"version"`` (:obj:`str`): Version of the pipeline template.
+            * ``"display_name"`` (:obj:`str`): Display name of the pipeline
+              template.
+            * ``"description"`` (:obj:`str`): Description of the pipeline template.
+            * ``"hosting_type"`` (:obj:`str`): Either ``"self-hosted"`` if the model
+              runs on the environment's infrastructure, or ``"private-api"`` if the
+              model inference is done through an external API.
+            * ``"model_family"`` (:obj:`str`): Model family of the pipeline
+              template.
           * ``"last_execution_id"`` (:obj:`str`): The id of the last execution of
             the pipeline.
     """
+    # Pipeline creation from a template
+    if pipeline_template_name is not None:
+        if (
+            function_path is not None
+            or function_name is not None
+            or description is not None
+            or container_config is not None
+            or inputs is not None
+            or outputs is not None
+            or len(kwargs) != 0
+        ):
+            raise ValueError(
+                "create_pipeline() got unexpected arguments. When specifying the "
+                "'pipeline_template_name' keyword argument, no other argument than "
+                "'pipeline_name' should be provided."
+            )
+
+        _create_pipeline_from_template(sdk, pipeline_name, pipeline_template_name)
+        return get_pipeline(sdk, pipeline_name, wait_for_completion, timeout_s)
+
     # For backward compatibility, a pipeline can be created with a single step:
     args_are_none = all(
         arg is None
@@ -333,6 +418,7 @@ def get_pipeline(
             * ``"data_type"`` (:obj:`str`): Input data type.
             * ``"is_required"`` (:obj:`bool`): Whether the input is required.
             * ``"default_value"`` (:obj:`str`): Input default value.
+            * ``"description"`` (:obj:`str`): Output description.
 
           * ``"outputs"`` (:obj:`list` of :obj:`dict`): List of outputs
             represented as a :obj:`dict` with the following keys:
@@ -369,6 +455,21 @@ def get_pipeline(
           * ``"status"`` (:obj:`str`): either ``"creation_pending"`` or ``"ready"``.
           * ``"origin"`` (:obj:`str`): The origin of the pipeline, can be
             ``"git_repository"`` or ``"local"``.
+          * ``"pipeline_template"`` (:obj:`dict` or :obj:`None`): The pipeline template
+            used to create the pipeline, :obj:`None` if the pipeline was not created
+            from a template. If not :obj:`None`, the dictionary has the following keys:
+
+            * ``"name"`` (:obj:`str`): Name of the pipeline template used as an
+              identifier to create the pipeline.
+            * ``"version"`` (:obj:`str`): Version of the pipeline template.
+            * ``"display_name"`` (:obj:`str`): Display name of the pipeline
+              template.
+            * ``"description"`` (:obj:`str`): Description of the pipeline template.
+            * ``"hosting_type"`` (:obj:`str`): Either ``"self-hosted"`` if the model
+              runs on the environment's infrastructure, or ``"private-api"`` if the
+              model inference is done through an external API.
+            * ``"model_family"`` (:obj:`str`): Model family of the pipeline
+              template.
           * ``"last_execution_id"`` (:obj:`str`): The id of the last execution of
             the pipeline.
     """

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/craft_ai_sdk/sdk.py

@@ -65,6 +65,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         delete_data_store_object,
         download_data_store_object,
         get_data_store_object_information,
+        iter_data_store_objects,
         list_data_store_objects,
         upload_data_store_object,
     )
@@ -102,6 +103,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         record_list_metric_values,
         record_metric_value,
     )
+    from .core.pipeline_templates import get_pipeline_template, list_pipeline_templates
     from .core.pipelines import (
         create_pipeline,
         delete_pipeline,
@@ -139,7 +141,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         os.environ.get("CRAFT_AI__MULTIPART_PART_SIZE__B", str(38 * 256 * 1024))
     )
     _access_token_margin = timedelta(seconds=30)
-    _version = "0.67.0rc1"  # Would be better to share it somewhere
+    _version = "0.67.1rc1"  # Would be better to share it somewhere
 
     def __init__(
         self,

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/craft_ai_sdk/shared/environments.py

@@ -5,7 +5,7 @@ from craft_ai_sdk.shared.request_response_handler import handle_http_response
 
 
 def get_environment_id(sdk: BaseCraftAiSdk):
-    health_url = f"{sdk.base_environment_api_url}/health"
+    health_url = f"{sdk.base_environment_api_url}/environment-info"
     health_result = requests.get(
         health_url,
         headers={
@@ -13,4 +13,4 @@ def get_environment_id(sdk: BaseCraftAiSdk):
         },
     )
     handle_http_response(health_result)
-    return health_result.json().get("environment_id", {}).get("info", "")
+    return health_result.json().get("environment_id")

{craft_ai_sdk-0.67.0rc1 → craft_ai_sdk-0.67.1rc1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "craft-ai-sdk"
-version = "0.67.0rc1"
+version = "0.67.1rc1"
 description = "Craft AI MLOps platform SDK"
 license = "Apache-2.0"
 authors = ["Craft AI <contact@craft.ai>"]